Interface CreateSessionOptions<ProgressEvents>

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

Type Parameters

ProgressEvents extends ProgressEvent<any, any> = ProgressEvent<any, any>

Hierarchy

AbortOptions
ProgressOptions<ProgressEvents>
- CreateSessionOptions

Index

Properties

maxProviders? minProviders? onProgress? signal?

Properties

`Optional` maxProviders

maxProviders?: number

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

Default

`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

`Optional` onProgress

onProgress?: ((evt) => void)

Type declaration

- (evt): void
- Parameters
  - evt: ProgressEvents
  Returns void

`Optional` signal

signal?: AbortSignal