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;
        signal?: AbortSignal;
    }

    Hierarchy

    Index

    Properties

    length? offline? offset? onProgress? path? 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

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties