# @helia/unixfs
[](https://ipfs.tech)
[](https://discuss.ipfs.tech)
[](https://codecov.io/gh/ipfs/helia)
[](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)
> A Helia-compatible wrapper for UnixFS
# About
`@helia/unixfs` is an implementation of a UnixFS filesystem compatible with Helia.
See the [API docs](https://ipfs.github.io/helia/modules/_helia_unixfs.html) for all available operations.
## Example - Creating files and directories
```typescript
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)
}
```
## Example - Recursively adding a directory
Node.js-compatibly environments only:
```typescript
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)
}
```
## Example - Adding files and directories in the browser
Uses [@cypsela/browser-source](https://github.com/cypsela/browser-source) to read [FileList](https://developer.mozilla.org/en-US/docs/Web/API/FileList), [FileSystemEntry](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemEntry), and [FileSystemHandle](https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle) files and directories.
Instances of these data types are available from [\](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input/file) elements, [drag-and-drop events](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/drop_event), and window methods like [showOpenFilePicker](https://developer.mozilla.org/en-US/docs/Web/API/Window/showOpenFilePicker).
```typescript
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 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)
}
```
# Install
```console
$ npm i @helia/unixfs
```
## Browser `
```
# API Docs
-
# License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/unixfs/LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/unixfs/LICENSE-MIT) / )
# Contribute
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) 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](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
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.
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
---
_Source: https://npm.io/package/@helia/unixfs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
