Interface MkdirOptions

Options to pass to the mkdir command

interface MkdirOptions {
    cidVersion: Version;
    force: boolean;
    mode?: number;
    mtime?: Mtime;
    offline?: boolean;
    onProgress?: ((evt) => void);
    shardSplitThresholdBytes: number;
    signal?: AbortSignal;
}

Hierarchy

Properties

cidVersion force mode? mtime? offline? onProgress? shardSplitThresholdBytes signal?

Properties

cidVersion

cidVersion: Version

The CID version to create the new directory with - defaults to the same version as the containing directory

force

force: boolean

If true, allow overwriting existing directory entries (default: false)

Optional mode

mode?: number

An optional mode to set on the new directory

Optional mtime

mtime?: Mtime

An optional mtime to set on the new directory

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

cidVersionforcemodemtimeofflineonProgressshardSplitThresholdBytessignal