Helia
    Preparing search index...

    Module @helia/utils

    Exports a Helia class that implements the Helia API.

    In general you should use the helia or @helia/http modules instead which pre-configure Helia for certain use-cases (p2p or pure-HTTP).

    import { Helia } from '@helia/utils'
    import type { HeliaInit } from '@helia/utils'

    const node = new Helia({
    // ...options
    } as HeliaInit)

    Helia logo

    @helia/utils

    ipfs.tech Discuss codecov CI

    Shared code that implements the Helia API

    About

    Exports a Helia class that implements the Helia API.

    In general you should use the helia or @helia/http modules instead which pre-configure Helia for certain use-cases (p2p or pure-HTTP).

    import { Helia } from '@helia/utils'
    import type { HeliaInit } from '@helia/utils'

    const node = new Helia({
    // ...options
    } as HeliaInit)

    Install

    $ npm i @helia/utils
    

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

    <script src="https://unpkg.com/@helia/utils/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.

    Classes

    AbstractSession
    BlockStorage
    Helia

    Interfaces

    AbstractCreateSessionOptions
    AbstractSessionComponents
    BlockStorageInit
    BlockstoreSessionEvents
    HeliaInit