@ipld/dag-json

@ipld/dag-json

JS implementation of DAG-JSON

Table of contents

• Install
• Example
• Usage
• License
• Contribute

Install

$ npm i @ipld/dag-json

Example

import { encode, decode } from '@ipld/dag-json'
import { CID } from 'multiformats'

const obj = {
  x: 1,
  /* CID instances are encoded as links */
  y: [2, 3, CID.parse('QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4')],
  z: {
    a: CID.parse('QmaozNR7DZHQK1ZcU9p7QdrshMvXqWK6gpu5rmrkPdT3L4'),
    b: null,
    c: 'string'
  }
}

let data = encode(obj)
let decoded = decode(data)
decoded.y[0] // 2
CID.asCID(decoded.z.a) // cid instance

Usage

@ipld/dag-json is designed to be used within multiformats but can be used separately. encode(), decode() are available as exports, as are name and code to match with the corresponding DAG-JSON multicodec.

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Changelog

9.1.0 (2022-12-19)

Features

• export parse / stringify functions (#88) (1ae3f70)