JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 173
  • Score
    100M100P100Q10244F
  • License MIT

IPLD Resolver Implementation in JavaScript

Package Exports

  • ipld-resolver

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ipld-resolver) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

IPLD Resolver

Coverage Status Travis CI Circle CI Dependency Status js-standard-style standard-readme compliant

Sauce Test Status

JavaScript implementation of the IPLD Resolver (internal DAG API module)

Table of Contents

Install

> npm install --save ipld-resolver

Usage

const Resolver = require('ipld-resolver')

// pass an optional blockService, if no blockService is passed,
// one is created in memory.
const Resolver = new Resolver(blockService)

API

.put(node, options, callback)

Store the given node of a recognized IPLD Format.

Options is an object that must contain one of the following combinations:

  • cid - the CID of the node
  • hashAlg and format - the hashAlg and the format that should be used to create the CID of the node

.get(cid [, path] [, options], callback)

Retrieve a node by the given cid or cid + path

options is an optional object containing:

  • localResolve: bool - if true, get will only attempt to resolve the path locally

callback should be a function with the signature function (err, result), the result being an object with:

  • value - the value that resulted from the get
  • remainderPath - If it didn't manage to successfully resolve the whole path through or if simply the localResolve option was passed.

.getStream(cid [, path] [, options])

Same as get, but returns a source pull-stream that is used to pass the fetched node.

.remove(cid, callback)

Remove a node by the given cid

.support.add(multicodec, formatResolver, formatUtil)

Add support to another IPLD Format

.support.rm(multicodec)

Removes support of an IPLD Format

Contribute

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

This repository falls under the IPFS Code of Conduct.

License

MIT