helia
    Preparing search index...

    Interface MkdirOptions

    Options to pass to the mkdir command

    interface MkdirOptions {
        cidVersion?: Version;
        force?: boolean;
        mode?: number;
        mtime?: Mtime;
        offline?: boolean;
        onProgress?: ProgressEventListener<PutBlockProgressEvents | GetEvents>;
        profile?: CIDProfile;
        providers?: (PeerId | Multiaddr | Multiaddr[])[];
        shardFanoutBits?: number;
        shardSplitStrategy?: ShardSplitStrategy;
        shardSplitThresholdBytes?: number;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cidVersion? force? mode? mtime? offline? onProgress? profile? providers? shardFanoutBits? shardSplitStrategy? shardSplitThresholdBytes? signal?

    Properties

    cidVersion?: Version

    the CID version to use when storing the data. Default: 1

    force?: boolean

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

    mode?: number

    An optional mode to set on the new directory

    mtime?: Mtime

    An optional mtime to set on the new directory

    offline?: boolean

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

    onProgress?: ProgressEventListener<PutBlockProgressEvents | GetEvents>
    profile?: CIDProfile

    The CID profile to use when calculating CIDs - see IPIP-499 for details

    https://github.com/ipfs/specs/pull/499

    providers?: (PeerId | Multiaddr | Multiaddr[])[]

    An optional list of peers known to host at least the root block of the DAG that will be fetched.

    If this list is omitted, or if the peers cannot supply the root or any child blocks, a findProviders routing query will be run to find peers that can supply the blocks.

    shardFanoutBits?: number

    The number of bits of a hash digest used at each level of sharding to the child index. 2**shardFanoutBits will dictate the maximum number of children for any shard in the HAMT.

    8
    shardSplitStrategy?: ShardSplitStrategy

    Whether to estimate the size of the data that determines whether to shard the directory instead by counting link bytes, or count it accurately by calculating the size of the resulting block.

    shardSplitThresholdBytes?: number

    If the serialized node is larger than this it might be converted to a HAMT sharded directory.

    262144
    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties