js-ipfs-unixfs
    Preparing search index...

    Interface ExportContentOptions

    interface ExportContentOptions {
        blockReadConcurrency?: number;
        length?: number;
        offline?: boolean;
        offset?: number;
        onProgress?: ProgressEventListener<ExporterProgressEvents>;
        signal?: AbortSignal;
    }

    Hierarchy

    Index
    blockReadConcurrency?: number

    When a DAG layer is encountered, child nodes are loaded in parallel up to this limit but processed as they arrive. This allows us to load sibling nodes in advance of yielding their bytes. Pass a value here to control the number of blocks loaded in parallel.

    If a strict depth-first traversal is required, this value should be set to 1, otherwise the traversal order will tend to resemble a breadth-first fan-out with stable ordering.

    10
    
    length?: number

    An optional length to read.

    If the CID resolves to a file this will be the number of bytes read from the file, otherwise if it's a directory it will be the number of directory entries read from the directory listing.

    undefined
    
    offline?: boolean

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

    false
    
    offset?: number

    An optional offset to start reading at.

    If the CID resolves to a file this will be a byte offset within that file, otherwise if it's a directory it will be a directory entry offset within the directory listing.

    undefined
    
    signal?: AbortSignal

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

    undefined