Interface RmOptions

Options to pass to the rm command

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

Hierarchy (View Summary)

AbortOptions
ProgressOptions<GetEvents | PutBlockProgressEvents>
- RmOptions
  - RmOptions

Index

Properties

offline? onProgress? shardSplitThresholdBytes signal?

Properties

`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: PutBlockProgressEvents | GetEvents) => void

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