Interface RmOptions

Options to pass to the rm command

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

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)

shardSplitThresholdBytes: number

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