Helia
    Preparing search index...

    Interface CatOptions

    Options to pass to the cat command

    interface CatOptions {
        length?: number;
        offline?: boolean;
        offset?: number;
        onProgress?: (evt: GetEvents) => void;
        path?: string;
        providers?: (PeerId | Multiaddr | Multiaddr[])[];
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    length? offline? offset? onProgress? path? providers? signal?

    Properties

    length?: number

    Stop reading the file after this many bytes

    offline?: boolean

    If true, do not perform any network operations and throw if blocks are missing from the local store. (default: false)

    offset?: number

    Start reading the file at this offset

    onProgress?: (evt: GetEvents) => void
    path?: string

    An optional path to allow reading files inside directories

    providers?: (PeerId | Multiaddr | Multiaddr[])[]

    An optional list of peers known to host at least the root block of the DAG that will be fetched.

    If this list is omitted, or if the peers cannot supply the root or any child blocks, a findProviders routing query will be run to find peers that can supply the blocks.

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties