Interface CreateSessionOptions<ProgressEvents>

interface CreateSessionOptions<ProgressEvents> {
    maxProviders?: number;
    minProviders?: number;
    onProgress?: ((evt) => void);
    signal?: AbortSignal;
}

Type Parameters

Hierarchy

Properties

maxProviders?: number

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

Default

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

Type declaration

signal?: AbortSignal