Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ipfs-inactive/js-ipfs-unixfs-engine
[ARCHIVED] JavaScript implementation of the layout and chunking mechanisms used by IPFS
https://github.com/ipfs-inactive/js-ipfs-unixfs-engine
Last synced: about 1 month ago
JSON representation
[ARCHIVED] JavaScript implementation of the layout and chunking mechanisms used by IPFS
- Host: GitHub
- URL: https://github.com/ipfs-inactive/js-ipfs-unixfs-engine
- Owner: ipfs-inactive
- License: mit
- Archived: true
- Created: 2016-01-04T16:14:50.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T15:11:19.000Z (over 4 years ago)
- Last Synced: 2024-05-21T01:04:53.877Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 20.3 MB
- Stars: 22
- Watchers: 22
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-peer-to-peer - ipfs-data-importing
README
# [ARCHIVED]
> This module has been merged into [ipfs/js-ipfs-unixfs](https://github.com/ipfs/js-ipfs-unixfs) where development continues. Please open issues/PRs there.
# ipfs-unixfs-engine
[](http://ipn.io)
[](http://ipfs.io/)
[](http://webchat.freenode.net/?channels=%23ipfs)
[](https://github.com/RichardLitt/standard-readme)
[](https://travis-ci.com/ipfs/js-ipfs-unixfs-engine)
[](https://codecov.io/gh/ipfs/js-ipfs-unixfs-engine)
[](https://david-dm.org/ipfs/js-ipfs-unixfs-engine)
[](https://github.com/feross/standard)
> JavaScript implementation of the layout and chunking mechanisms used by IPFS to handle Files
## Lead Maintainer
[Alex Potsides](https://github.com/achingbrain)
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Importing a file](#importing-a-file)
- [Exporting a file](#exporting-a-file)
- [Contribute](#contribute)
- [License](#license)
## Install
```
> npm install ipfs-unixfs-engine
```
## Usage
The `unixfs-engine` exports the [`unixfs-importer`](https://npmjs.com/packages/ipfs-unixfs-importer) and [`unixfs-exporter`](https://npmjs.com/packages/ipfs-unixfs-exporter) modules. Please see those modules for for full documentation.
### Importing a file
The importer is a [pull-stream through](https://github.com/pull-stream/pull-stream#through) which takes objects of the form `{ path, content }` where `path` is a string path and `content` can be a `Buffer`, a `ReadableStream` or a `pull-stream` that emits `Buffer`s.
It requires an [ipld](https://npmjs.com/packages/ipld) resolver to persist [DAGNodes](https://npmjs.com/packages/ipld-dag-pb) and make them available over IPFS.
See the [`unixfs-importer`](https://npmjs.com/packages/ipfs-unixfs-importer) module for full documentation.
```js
const {
importer
} = require('ipfs-unixfs-engine')
const pull = require('pull-stream')
const fs = require('fs')
// Import path /tmp/bar.txt
pull(
pull.values([{
path: '/tmp/bar.txt',
content: fs.createReadStream('/tmp/bar.txt')
}]),
// You need to create and pass an ipld resolver instance
// https://npmjs.com/packages/ipld
importer(, ),
// Handle the error and do something with the results
pull.collect((err, files) => {
console.info(files)
// Prints:
// [{
// size: 12,
// leafSize: 4,
// multihash:
// path: '/tmp/bar.txt',
// name: ''
// }, {
// path: 'tmp',
// multihash:
// size: 65
// }]
})
)
```
### Exporting a file
The exporter is a [pull-stream source](https://github.com/pull-stream/pull-stream#source-readable-stream-that-produces-values) which takes a [cid](https://npmjs.com/packages/cids) and an [ipld](https://npmjs.com/packages/ipld) resolver.
See the [`unixfs-exporter`](https://npmjs.com/packages/ipfs-unixfs-exporter) module for full documentation.
```js
const {
exporter
} = require('ipfs-unixfs-engine').exporter
const pull = require('pull-stream')
const drain = require('pull-stream/sinks/drain')
pull(
// You need to create and pass an ipld resolver instance
// https://npmjs.com/packages/ipld
exporter(cid, ipld),
drain((file) => {
// file.content is a pull stream containing the bytes of the file
})
)
```
## Contribute
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs-unixfs-engine/issues)!
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
## License
[MIT](LICENSE)