Module @helia/json

@helia/json makes working with JSON in Helia simple & straightforward.

See the JSON interface for all available operations.

Example

import { createHelia } from 'helia'
import { json } from '@helia/json'
import { CID } from 'multiformats/cid'

const j = json(helia)
const cid = await j.put({
hello: 'world'
})
const obj = await j.get(cid)

console.info(obj)
// { hello: 'world' }

Helia logo

@helia/json

ipfs.tech Discuss codecov CI

Add/get IPLD blocks containing json with your Helia node

About

@helia/json makes working with JSON in Helia simple & straightforward.

See the JSON interface for all available operations.

Example

import { createHelia } from 'helia'
import { json } from '@helia/json'
import { CID } from 'multiformats/cid'

const j = json(helia)
const cid = await j.put({
hello: 'world'
})
const obj = await j.get(cid)

console.info(obj)
// { hello: 'world' }

Install

$ npm i @helia/json

Browser <script> tag

Loading this module through a script tag will make it's exports available as HeliaJson in the global namespace.

<script src="https://unpkg.com/@helia/json/dist/index.min.js"></script>

API Docs

License

Licensed under either of

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

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.

Index

Interfaces

Functions

Generated using TypeDoc