helia

An implementation of IPFS in JavaScript

About

Exports a createHelia function that returns an object that implements the Helia API.

Pass it to other modules like @helia/unixfs to make files available on the distributed web.

Example

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

const helia = await createHelia()

const fs = unixfs(helia)
fs.cat(CID.parse('bafyFoo'))
Copy

Install

$ npm i helia
Copy

Browser <script> tag

Loading this module through a script tag will make its exports available as Helia in the global namespace.

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

API Docs

• https://ipfs.github.io/helia/modules/helia.html

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

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.