Interface AbstractCreateSessionOptions

interface AbstractCreateSessionOptions {
    maxProviders?: number;
    minProviders?: number;
    name: string;
    onProgress?: ((evt) => void);
    signal?: AbortSignal;
}

Hierarchy (view full)

Properties

maxProviders? minProviders? name onProgress? signal?

Properties

Optional maxProviders

maxProviders?: number

The maximum number of providers for the root CID to be added to a session.

Default

5

Optional minProviders

minProviders?: number

The minimum number of providers for the root CID that are required for successful session creation.

The session will become usable once this many providers have been discovered, up to maxProviders providers will continue to be added.

Default

1

name

name: string

Optional onProgress

onProgress?: ((evt) => void)

Type declaration

Optional signal

signal?: AbortSignal

Settings

Member Visibility

Theme

On This Page

maxProvidersminProvidersnameonProgresssignal