Interface RmOptions

Options to pass to the rm command

interface RmOptions {
    force: boolean;
    offline?: boolean;
    onProgress?: ((evt) => void);
    shardSplitThresholdBytes: number;
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

force offline? onProgress? shardSplitThresholdBytes signal?

Properties

force

force: boolean

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

Optional offline

offline?: boolean

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

Optional onProgress

onProgress?: ((evt) => void)

Type declaration

shardSplitThresholdBytes

shardSplitThresholdBytes: number

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

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

forceofflineonProgressshardSplitThresholdBytessignal