Skip to content

Commit

Permalink
chore: update sibling dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
aegir[bot] committed Dec 3, 2023
1 parent ffe7629 commit 1b0b2ef
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions packages/unixfs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,49 @@

> A Helia-compatible wrapper for UnixFS
# About

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

See the interface for all available operations.

## Example

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

const helia = createHelia({
// ... helia config
})
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)
}
```

## Example

Recursively adding a directory (Node.js-compatibly environments only):

```typescript
import { globSource } from '@helia/unixfs'

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

## Table of contents <!-- omit in toc -->

- [Install](#install)
Expand Down

0 comments on commit 1b0b2ef

Please sign in to comment.