ipfs-multipart

ipfs-multipart

A set of utilities to help dealing with IPFS multipart.

Lead Maintainer

Hugo Dias

Notice

This module is moving to async iterators starting from 0.2.0.
The last minor version to support event emitter is 0.1.1, any backports will merged to the branch event-emitter and released under >0.1.0 <0.2.0.

Install

npm install ipfs-multipart

Usage

const http = require('http')
const parser = require('ipfs-multipart')

http.createServer(async (req, res) => {
  if (req.method === 'POST' && req.headers['content-type']) {

    for await (const entry of parser(req)) {
      if (entry.type === 'directory') {
        console.log(`dir ${entry.name} start`)
      }

      if (entry.type === 'file') {
        console.log(`file ${entry.name} start`)

        for await (const data of entry.content) {
          console.log(`file ${entry.name} contents:`, data.toString())
        }

        console.log(`file ${entry.name} end`)
      }
    }

    console.log('finished parsing')
    res.writeHead(200)
    res.end()
  }

  res.writeHead(404)
  res.end()
}).listen(5001, () => {
  console.log('server listening on port 5001')
})

Contribute

See the contribute file and our code of conduct!

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

MIT © Protocol Labs Inc.

Changelog

0.2.0 (2019-08-27)

Chores

• refactor to async/await (#17) (55d926e)

BREAKING CHANGES

• This module used to export a class that extended EventEmitter, now it exports a function that returns an async iterable.

I also updated the deps to use the latest http api, though it's removed the ability to add whole paths at once, along with some special logic to handle symlinks. The Dicer module that this module depends on will still emit events for when it encounters symlinks so I left the handlers in though am unsure if we actually use them.

<a name="0.1.1"></a>