ipfs-unixfs

JavaScript implementation of IPFS' UnixFS (a representation of a Unix file system on top of a MerkleDAG)

The UnixFS spec can be found at ipfs/specs/UNIXFS.md

Lead Maintainer

Alex Potsides

Table of Contents

• Install
  • npm
  • Use in Node.js
  • Use in a browser with browserify, webpack or any other bundler
  • Use in a browser Using a script tag
• Usage
  • Examples
    • Create a file composed by several blocks
    • Create a directory that contains several files
• API
  • UnixFS Data Structure
  • create an unixfs Data element
  • add and remove a block size to the block size list
  • get total fileSize
  • marshal and unmarshal
  • is this UnixFS entry a directory?
  • has an mtime been set?
• Contribute
• License

Structure

• /packages/ipfs-unixfs Serialization/deserialization of UnixFS objects to protocol buffers
• /packages/ipfs-unixfs-importer Builds DAGs from files and directories
• /packages/ipfs-unixfs-exporter Exports DAGs

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT