https://github.com/ipfs/js-ipfs-unixfs

JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)
https://github.com/ipfs/js-ipfs-unixfs

Last synced: 4 months ago
JSON representation

JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)

• Host: GitHub
• URL: https://github.com/ipfs/js-ipfs-unixfs
• Owner: ipfs
• License: other
• Created: 2016-02-10T07:55:49.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2026-02-10T13:41:46.000Z (4 months ago)
• Last Synced: 2026-02-10T13:57:33.208Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 16.5 MB
• Stars: 93
• Watchers: 23
• Forks: 33
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# js-ipfs-unixfs

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)

[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)

[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs-unixfs)

[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-unixfs/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> JS implementation of the IPFS UnixFS

The UnixFS spec can be found at [ipfs/specs/UNIXFS.md](https://github.com/ipfs/specs/blob/master/UNIXFS.md)

# Packages

- [`benchmarks/import`](https://github.com/ipfs/js-ipfs-unixfs/tree/main/benchmarks/import) Import benchmarks for ipfs-unixfs-importer

- [`benchmarks/memory`](https://github.com/ipfs/js-ipfs-unixfs/tree/main/benchmarks/memory) Memory benchmarks for ipfs-unixfs-importer

- [`packages/ipfs-unixfs`](https://github.com/ipfs/js-ipfs-unixfs/tree/main/packages/ipfs-unixfs) JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)

- [`packages/ipfs-unixfs-exporter`](https://github.com/ipfs/js-ipfs-unixfs/tree/main/packages/ipfs-unixfs-exporter) JavaScript implementation of the UnixFs exporter used by IPFS

- [`packages/ipfs-unixfs-importer`](https://github.com/ipfs/js-ipfs-unixfs/tree/main/packages/ipfs-unixfs-importer) JavaScript implementation of the UnixFs importer used by IPFS

# API Docs

- 

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-ipfs-unixfs/blob/main/LICENSE-APACHE) / )

- MIT ([LICENSE-MIT](https://github.com/ipfs/js-ipfs-unixfs/blob/main/LICENSE-MIT) / )

# Contribute

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs-unixfs/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://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)