Interface AddOptions

interface AddOptions {
    depth?: number;
    metadata?: Record<string, string | number | boolean>;
    onProgress?: ((evt) => void);
    signal?: AbortSignal;
}

Hierarchy

Properties

depth? metadata? onProgress? signal?

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?: ((evt) => void)

Type declaration

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

depthmetadataonProgresssignal