ipfs-unixfs-importer
![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs-unixfs/js-test-and-release.yml?branch=main&style=flat-square)
JavaScript implementation of the UnixFs importer used by IPFS
About
Example
Let's create a little directory to import:
> cd /tmp
> mkdir foo
> echo 'hello' > foo/bar
> echo 'world' > foo/quux
And write the importing logic:
import { importer } from 'ipfs-unixfs-importer'
import { MemoryBlockstore } from 'blockstore-core/memory'
import * as fs from 'node:fs'
const blockstore = new MemoryBlockstore()
const source = [{
path: '/tmp/foo/bar',
content: fs.createReadStream('/tmp/foo/bar')
}, {
path: '/tmp/foo/quxx',
content: fs.createReadStream('/tmp/foo/quux')
}]
for await (const entry of importer(source, blockstore)) {
console.info(entry)
}
When run, metadata about DAGNodes in the created tree is printed until the root:
{
cid: CID,
path: 'tmp/foo/bar',
unixfs: UnixFS
}
{
cid: CID,
path: 'tmp/foo/quxx',
unixfs: UnixFS
}
{
cid: CID,
path: 'tmp/foo',
unixfs: UnixFS
}
{
cid: CID,
path: 'tmp',
unixfs: UnixFS
}
Install
$ npm i ipfs-unixfs-importer
Browser <script>
tag
Loading this module through a script tag will make its exports available as IpfsUnixfsImporter
in the global namespace.
<script src="https://unpkg.com/ipfs-unixfs-importer/dist/index.min.js"></script>
API Docs
License
Licensed under either of
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.
![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)