Class GraphSearch

A traversal strategy that performs a depth-first search looking for a target CID.

Implements

TraversalStrategy

Index

Constructors

Methods

Constructors

constructor

new GraphSearch(needle: CID, options?: GraphSearchOptions): GraphSearch
Parameters
- needle: CID
- Optionaloptions: GraphSearchOptions
Returns GraphSearch
- Defined in packages/car/src/traversal-strategies/graph-search.ts:31
new GraphSearch(
    haystack: CID,
    needle: CID,
    options?: GraphSearchOptions,
): GraphSearch
Parameters
- haystack: CID
- needle: CID
- Optionaloptions: GraphSearchOptions
Returns GraphSearch
- Defined in packages/car/src/traversal-strategies/graph-search.ts:32

Methods

traverse

traverse(
    root: CID,
    blockstore: Blockstore,
    getCodec: CodecLoader,
    options?: AbortOptions,
): AsyncGenerator<
    BlockView<unknown, number, number, 0 | 1>,
    void,
    undefined,
>
Traverse the DAG and yield the next CID to traverse
Parameters
- root: CID
- blockstore: Blockstore
- getCodec: CodecLoader
- Optionaloptions: AbortOptions
Returns AsyncGenerator<BlockView<unknown, number, number, 0 | 1>, void, undefined>
Implementation of TraversalStrategy.traverse
- Defined in packages/car/src/traversal-strategies/graph-search.ts:48