Interface AddOptions

interface AddOptions {
    depth?: number;
    metadata?: Record<string, string | number | boolean>;
    onProgress?: ProgressEventListener<GetBlockProgressEvents | AddPinEvents>;
    signal?: AbortSignal;
    walker?: GraphWalkerFactory;
}

Hierarchy

AbortOptions
ProgressOptions<AddPinEvents | GetBlockProgressEvents>
- AddOptions

Index

Properties

depth? metadata? onProgress? signal? walker?

Properties

`Optional`depth

depth?: number

How deeply to pin the DAG, defaults to Infinity

`Optional`metadata

metadata?: Record<string, string | number | boolean>

Optional user-defined metadata to store with the pin

`Optional`onProgress

onProgress?: ProgressEventListener<GetBlockProgressEvents | AddPinEvents>

`Optional`signal

signal?: AbortSignal

`Optional`walker

walker?: GraphWalkerFactory

Walker factory used to traverse the DAG. Default: depthFirstWalker().