Helia
    Preparing search index...

    Interface RmOptions

    Options to pass to the rm command

    interface RmOptions {
        force: boolean;
        offline?: boolean;
        onProgress?: (evt: GetEvents | PutBlockProgressEvents) => void;
        providers?: (PeerId | Multiaddr | Multiaddr[])[];
        shardSplitThresholdBytes: number;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    force offline? onProgress? providers? shardSplitThresholdBytes signal?

    Properties

    force: boolean

    If true, allow attempts to delete files or directories that do not exist (default: false)

    offline?: boolean

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

    onProgress?: (evt: GetEvents | PutBlockProgressEvents) => void
    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.

    shardSplitThresholdBytes: number

    DAGs with a root block larger than this value will be sharded. Blocks smaller than this value will be regular UnixFS directories.

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties