1- # ipfs-unixfs-exporter
1+ # ipfs-unixfs-exporter <!-- omit in toc -->
2+
3+ [ ![ ipfs.io] ( https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square )] ( http://ipfs.io )
4+ [ ![ IRC] ( https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square )] ( http://webchat.freenode.net/?channels=%23ipfs )
5+ [ ![ Discord] ( https://img.shields.io/discord/806902334369824788?style=flat-square )] ( https://discord.gg/ipfs )
6+ [ ![ codecov] ( https://img.shields.io/codecov/c/github/ipfs/js-ipfs-unixfs.svg?style=flat-square )] ( https://codecov.io/gh/ipfs/js-ipfs-unixfs )
7+ [ ![ CI] ( https://img.shields.io/github/workflow/status/ipfs/js-ipfs-unixfs/test%20&%20maybe%20release/master?style=flat-square )] ( https://github.com/ipfs/js-ipfs-unixfs/actions/workflows/js-test-and-release.yml )
8+
9+ > JavaScript implementation of the UnixFs exporter used by IPFS
10+
11+ ## Table of contents <!-- omit in toc -->
12+
13+ - [ Install] ( #install )
14+ - [ Lead Maintainer] ( #lead-maintainer )
15+ - [ Usage] ( #usage )
16+ - [ Example] ( #example )
17+ - [ API] ( #api )
18+ - [ ` exporter(cid, blockstore, options) ` ] ( #exportercid-blockstore-options )
19+ - [ UnixFSEntry] ( #unixfsentry )
20+ - [ Raw entries] ( #raw-entries )
21+ - [ CBOR entries] ( #cbor-entries )
22+ - [ ` entry.content({ offset, length }) ` ] ( #entrycontent-offset-length- )
23+ - [ ` walkPath(cid, blockstore) ` ] ( #walkpathcid-blockstore )
24+ - [ ` recursive(cid, blockstore) ` ] ( #recursivecid-blockstore )
25+ - [ Contribute] ( #contribute )
26+ - [ License] ( #license )
27+ - [ Contribute] ( #contribute-1 )
228
3- [ ![ ] ( https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square )] ( http://ipn.io )
4- [ ![ ] ( https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square )] ( http://ipfs.io/ )
5- [ ![ ] ( https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square )] ( http://webchat.freenode.net/?channels=%23ipfs )
6- [ ![ Build Status] ( https://flat.badgen.net/travis/ipfs/js-ipfs-unixfs )] ( https://travis-ci.com/ipfs/js-ipfs-unixfs )
7- [ ![ Codecov] ( https://codecov.io/gh/ipfs/js-ipfs-unixfs/branch/master/graph/badge.svg )] ( https://codecov.io/gh/ipfs/js-ipfs-unixfs )
29+ ## Install
830
9- > Exports UnixFS and other DAGs from IPFS
31+ ``` console
32+ $ npm i ipfs-unixfs-exporter
33+ ```
1034
1135## Lead Maintainer
1236
1337[ Alex Potsides] ( https://github.com/achingbrain )
1438
15- ## Table of Contents
16-
17- - [ ipfs-unixfs-exporter] ( #ipfs-unixfs-exporter )
18- - [ Lead Maintainer] ( #lead-maintainer )
19- - [ Table of Contents] ( #table-of-contents )
20- - [ Install] ( #install )
21- - [ Usage] ( #usage )
22- - [ Example] ( #example )
23- - [ API] ( #api )
24- - [ ` exporter(cid, blockstore, options) ` ] ( #exportercid-blockstore-options )
25- - [ UnixFSEntry] ( #unixfsentry )
26- - [ Raw entries] ( #raw-entries )
27- - [ CBOR entries] ( #cbor-entries )
28- - [ ` entry.content({ offset, length }) ` ] ( #entrycontent-offset-length- )
29- - [ ` walkPath(cid, blockstore) ` ] ( #walkpathcid-blockstore )
30- - [ ` recursive(cid, blockstore) ` ] ( #recursivecid-blockstore )
31- - [ Contribute] ( #contribute )
32- - [ License] ( #license )
33-
34- ## Install
35-
36- ```
37- > npm install ipfs-unixfs-exporter
38- ```
39-
4039## Usage
4140
4241### Example
@@ -238,7 +237,9 @@ for await (const child of recursive('Qmfoo/foo/bar', blockstore)) {
238237` ` `
239238
240239[dag API]: https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/DAG.md
240+
241241[blockstore]: https://github.com/ipfs/js-ipfs-interfaces/tree/master/packages/interface-blockstore#readme
242+
242243[UnixFS]: https://github.com/ipfs/specs/tree/master/unixfs
243244
244245## Contribute
@@ -251,4 +252,15 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
251252
252253## License
253254
254- [MIT](LICENSE)
255+ Licensed under either of
256+
257+ - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
258+ - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
259+
260+ ## Contribute
261+
262+ Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-importer/issues)!
263+
264+ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
265+
266+ [](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
0 commit comments