Helia
    Preparing search index...

    Module helia

    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.

    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'))

    Helia logo

    helia

    ipfs.tech Discuss codecov CI

    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.

    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'))

    Install

    $ npm i helia
    

    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>
    

    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

    InsufficientProvidersError
    NoRoutersAvailableError
    UnknownCodecError
    UnknownHashAlgorithmError

    Interfaces

    AddOptions
    BlockAnnounceOptions
    BlockBroker
    BlockRetrievalOptions
    Blocks
    CodecLoader
    CreateSessionOptions
    DAGWalker
    DefaultLibp2pServices
    GCOptions
    GetOfflineOptions
    HasherLoader
    Helia
    HeliaInit
    HeliaLibp2p
    IsPinnedOptions
    Libp2pDefaultsOptions
    LsOptions
    Pair
    Pin
    Pins
    Provider
    ProviderOptions
    RmOptions
    Routing
    RoutingOptions
    SessionBlockstore

    Type Aliases

    AddPinEvents
    Await
    AwaitIterable
    DeleteBlockProgressEvents
    DeleteManyBlocksProgressEvents
    GcEvents
    GetAllBlocksProgressEvents
    GetBlockProgressEvents
    GetManyBlocksProgressEvents
    HasBlockProgressEvents
    PinType
    PutBlockProgressEvents
    PutManyBlocksProgressEvents

    Variables

    DEFAULT_SESSION_MAX_PROVIDERS
    DEFAULT_SESSION_MIN_PROVIDERS

    Functions

    createHelia
    heliaDefaults
    libp2pDefaults