Interface Helia

The API presented by a Helia node

interface Helia {
    blockstore: Blocks;
    dagWalkers: Record<number, DAGWalker>;
    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
    dns: DNS;
    hashers: Record<number, MultihashHasher<number>>;
    logger: ComponentLogger;
    metrics?: Metrics;
    pins: Pins;
    routing: Routing;
    gc(options?): Promise<void>;
    start(): Promise<void>;
    stop(): Promise<void>;
}

Hierarchy (view full)

Implemented by

    Properties

    blockstore dagWalkers datastore dns hashers logger metrics? pins routing

    Methods

    gc start stop

    Properties

    blockstore

    blockstore: Blocks

    Where the blocks are stored

    dagWalkers

    dagWalkers: Record<number, DAGWalker>

    DAGWalkers are codec-specific implementations that know how to yield all CIDs contained within a block that corresponds to that codec.

    datastore

    datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

    A key/value store

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Type declaration

                    Type declaration

                      Type declaration

                        dns

                        dns: DNS

                        The DNS property can be used to perform lookups of various record types and will use a resolver appropriate to the current platform.

                        hashers

                        hashers: Record<number, MultihashHasher<number>>

                        Hashers can be used to hash a piece of data with the specified hashing algorithm.

                        logger

                        logger: ComponentLogger

                        A logging component that can be reused by consumers

                        Optional metrics

                        metrics?: Metrics

                        A metrics object that can be used to collected arbitrary stats about node usage.

                        pins

                        pins: Pins

                        Pinning operations for blocks in the blockstore

                        routing

                        routing: Routing

                        The routing component allows performing operations such as looking up content providers, information about peers, etc.

                        Methods

                        gc

                        • gc(options?): Promise<void>

                        • Remove any unpinned blocks from the blockstore

                          Parameters

                          Returns Promise<void>

                        start

                        • start(): Promise<void>

                        • Starts the Helia node

                          Returns Promise<void>

                        stop

                        • stop(): Promise<void>

                        • Stops the Helia node

                          Returns Promise<void>

                        Settings

                        Member Visibility

                        Theme

                        On This Page

                        blockstoredagWalkersdatastorednshashersloggermetricspinsroutinggcstartstop