Skip to main content

Abstract Class: BaseProvider

Defined in: packages/client/src/providers/base.ts:7

State and change notification for providers. Subclasses implement detect and createSession, and call setState.

Extended by​

Implements​

Constructors​

Constructor​

protected new BaseProvider(id, label, locality, initial): BaseProvider

Defined in: packages/client/src/providers/base.ts:11

Parameters​

id​

string

label​

string

locality​

Locality

initial​

ProviderState

Returns​

BaseProvider

Properties​

id​

readonly id: string

Defined in: packages/client/src/providers/base.ts:12

Implementation of​

Provider.id

label​

readonly label: string

Defined in: packages/client/src/providers/base.ts:13

Implementation of​

Provider.label

locality​

readonly locality: Locality

Defined in: packages/client/src/providers/base.ts:14

Implementation of​

Provider.locality

Methods​

createSession()​

abstract createSession(options): Promise<ProviderSession>

Defined in: packages/client/src/providers/base.ts:28

Parameters​

options​

SessionOptions

Returns​

Promise<ProviderSession>

Implementation of​

Provider.createSession

detect()​

abstract detect(): Promise<void>

Defined in: packages/client/src/providers/base.ts:27

Check availability. Cheap and safe to call often.

Returns​

Promise<void>

Implementation of​

Provider.detect

getState()​

getState(): ProviderState

Defined in: packages/client/src/providers/base.ts:20

Current state; the core re-reads it after onChange fires.

Returns​

ProviderState

Implementation of​

Provider.getState

onChange()​

onChange(listener): () => void

Defined in: packages/client/src/providers/base.ts:22

Subscribe to state changes. Returns the unsubscribe function.

Parameters​

listener​

() => void

Returns​

() => void

Implementation of​

Provider.onChange

setState()​

protected setState(patch): void

Defined in: packages/client/src/providers/base.ts:30

Parameters​

patch​

Partial<ProviderState>

Returns​

void