Module index

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 FileList, FileSystemEntry, and FileSystemHandle files and directories.

Instances of these data types are available from <input type="file" /> elements, drag-and-drop events, and window methods like showOpenFilePicker.

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

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

// get FileList from <input type="file" /> elements
const fileList = {} as FileList

for await (const entry of fs.addAll(fileListSource(fileList))) {
  console.info(entry)
}

// 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