Interface RmOptions

Options to pass to the rm command

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

Hierarchy

AbortOptions
ProgressOptions<GetEvents | PutBlockProgressEvents>
- 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) => void)

Type declaration

- (evt): void
- Parameters
  - evt: GetEvents | PutBlockProgressEvents
  Returns 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