@helia/unixfs

A Helia-compatible wrapper for UnixFS

About

@helia/unixfs is an implementation of a UnixFS filesystem compatible with Helia.

See the API docs for all available operations.

Example - Creating files and directories

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

const helia = await createHelia()
const fs = unixfs(helia)

// create an empty dir and a file, then add the file to the dir
const emptyDirCid = await fs.addDirectory()
const fileCid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3]))
const updateDirCid = await fs.cp(fileCid, emptyDirCid, 'foo.txt')

// or doing the same thing as a stream
for await (const entry of fs.addAll([{
  path: 'foo.txt',
  content: Uint8Array.from([0, 1, 2, 3])
}])) {
  console.info(entry)
}
Copy

Example - Recursively adding a directory

Node.js-compatibly environments only:

import { createHelia } from 'helia'
import { unixfs } from '@helia/unixfs'
import { globSource } from '@helia/unixfs'

const helia = await createHelia()
const fs = unixfs(helia)

for await (const entry of fs.addAll(globSource('path/to/containing/dir', 'glob-pattern'))) {
  console.info(entry)
}
Copy

Example - Adding files and directories in the browser

Uses @cypsela/browser-source to read FileSystemEntry and FileSystemHandle files and directories.

Instances of these data types are available from drag and drop events and window methods like showOpenFilePicker.

import { createHelia } from 'helia'
import { unixfs } from '@helia/unixfs'
import { fsEntrySource, fsHandleSource } from '@cypsela/browser-source'

const helia = await createHelia()
const fs = unixfs(helia)

// get FileSystemEntry from drag and drop events
const fileEntry = {} as FileSystemEntry

for await (const entry of fs.addAll(fsEntrySource(fileEntry))) {
  console.info(entry)
}

// get FileSystemHandle from drag and drop events or window methods
const fileHandle = {} as FileSystemHandle

for await (const entry of fs.addAll(fsHandleSource(fileHandle))) {
  console.info(entry)
}
Copy

Install

$ npm i @helia/unixfs
Copy

Browser <script> tag

Loading this module through a script tag will make its exports available as HeliaUnixfs in the global namespace.

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

API Docs

• https://ipfs.github.io/helia/modules/_helia_unixfs.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

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.