js-ipfs-unixfs
    Preparing search index...

    Interface WalkPathOptions

    interface WalkPathOptions {
        offline?: boolean;
        onProgress?: (evt: ExporterProgressEvents) => void;
        signal?: AbortSignal;
        translateHamtPath?: boolean;
        yieldSubShards?: boolean;
    }

    Hierarchy

    Index

    Properties

    offline? onProgress? signal? translateHamtPath? yieldSubShards?

    Properties

    offline?: boolean

    Passed to the underlying block store - may prevent network operations if set to true.

    false
    onProgress?: (evt: ExporterProgressEvents) => void
    signal?: AbortSignal

    This signal can be used to abort any long-lived operations such as fetching blocks from the network.

    undefined
    translateHamtPath?: boolean

    If a HAMT-sharded directory is encountered, paths will be translated automatically, e.g. QmHamt/bar.txt -> QmHamt/F0/A1bar.txt, pass false here to not perform this translation.

    true
    yieldSubShards?: boolean

    By default if a HAMT-sharded directory is encountered, only file and directory entries are yielded. Pass true here to also yield intermediate sub-shards.

    false

    Settings

    Member Visibility

    On This Page

    Properties