js-ipfs-http-response

Creates an HTTP response from an IPFS Hash

Lead Maintainer

Vasco Santos.

Installation

npm install ipfs-http-response

Usage

Creating HTTP Response

This project creates a HTTP response for an IPFS Path. This response can be a file, a HTML with directory listing or the entry point of a web page.

const { getResponse } = require('ipfs-http-response')

getResponse(ipfsNode, ipfsPath)
  .then((result) => {
    ...
  })

Using protocol-agnostic resolver

This module also exports the used ipfs resolver, which should be used when the response needs to be customized or non-HTTP transport is used:

const { resolver } = require('ipfs-http-response')

resolver.cid(ipfsNode, ipfsPath)
  .then((result) => {
    ...
  })

If ipfsPath points at a directory, resolver.cid will throw Error This dag node is a directory with a cid attribute that can be passed to resolver.directory:

const { resolver } = require('ipfs-http-response')

resolver.directory(ipfsNode, ipfsPath, cid)
  .then((result) => {
    ...
  })

result will be either a string with HTML directory listing or an array with CIDs of index pages present in inspected directory.