Module @helia/mfs

@helia/mfs is an implementation of a Mutable File System powered by Helia.

See the API docs for all available operations.

Example

import { createHelia } from 'helia'
import { mfs } from '@helia/mfs'

const helia = createHelia({
// ... helia config
})
const fs = mfs(helia)

// create an empty directory
await fs.mkdir('/my-directory')

// add a file to the directory
await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/my-directory/foo.txt')

// read the file
for await (const buf of fs.cat('/my-directory/foo.txt')) {
console.info(buf)
}

Helia logo

@helia/mfs

ipfs.tech Discuss codecov CI

A mutable filesystem powered by Helia

About

@helia/mfs is an implementation of a Mutable File System powered by Helia.

See the API docs for all available operations.

Example

import { createHelia } from 'helia'
import { mfs } from '@helia/mfs'

const helia = createHelia({
// ... helia config
})
const fs = mfs(helia)

// create an empty directory
await fs.mkdir('/my-directory')

// add a file to the directory
await fs.writeBytes(Uint8Array.from([0, 1, 2, 3]), '/my-directory/foo.txt')

// read the file
for await (const buf of fs.cat('/my-directory/foo.txt')) {
console.info(buf)
}

Install

$ npm i @helia/mfs

Browser <script> tag

Loading this module through a script tag will make it's exports available as HeliaMfs in the global namespace.

<script src="https://unpkg.com/@helia/mfs/dist/index.min.js"></script>

API Docs

License

Licensed under either of

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Index

Interfaces

Type Aliases

Functions

Generated using TypeDoc