Helia
    Preparing search index...

    Interface ExportCarOptions

    interface ExportCarOptions {
        blockFilter?: Filter;
        exporter?: ExportStrategy;
        offline?: boolean;
        onProgress?: (evt: GetBlockProgressEvents) => void;
        providers?: (PeerId | Multiaddr | Multiaddr[])[];
        signal?: AbortSignal;
        traversal?: TraversalStrategy;
    }

    Hierarchy (View Summary)

    Index

    Properties

    blockFilter? exporter? offline? onProgress? providers? signal? traversal?

    Properties

    blockFilter?: Filter

    If a filter is passed it will be used to deduplicate blocks exported in the car file

    exporter?: ExportStrategy

    Export strategy to use for the export. This should be used to change the blocks included in the exported car file. (e.g. https://specs.ipfs.tech/http-gateways/trustless-gateway/#dag-scope-request-query-parameter)

    offline?: boolean

    If true, the blockstore will not do any network requests.

    false
    onProgress?: (evt: GetBlockProgressEvents) => void
    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.

    signal?: AbortSignal
    traversal?: TraversalStrategy

    The traversal strategy to use for the export. This determines how the dag is traversed: either depth first, breadth first, or a custom strategy.

    Settings

    Member Visibility

    On This Page

    Properties