Helia
    Preparing search index...

    Interface LsOptions

    Options to pass to the ls command

    interface LsOptions {
        extended?: boolean;
        length?: number;
        offline?: boolean;
        offset?: number;
        onProgress?: (evt: GetEvents) => void;
        path?: string;
        signal?: AbortSignal;
    }

    Hierarchy

    Index

    Properties

    extended? length? offline? offset? onProgress? path? signal?

    Properties

    extended?: boolean

    If true, including UnixFS metadata in the output - nb. this will resolve the root node of every encountered filesystem entry

    true
    length?: number

    Stop reading the directory contents after this many directory entries

    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 directory entries at this offset

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

    Optional path to list subdirectory contents if the target CID resolves to a directory

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties