Skip to main content

Class: ServerProvider

Defined in: packages/client/src/providers/server.ts:47

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

Extends​

Constructors​

Constructor​

new ServerProvider(options): ServerProvider

Defined in: packages/client/src/providers/server.ts:48

Parameters​

options​

ServerProviderOptions

Returns​

ServerProvider

Overrides​

BaseProvider.constructor

Properties​

id​

readonly id: string

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

Inherited from​

BaseProvider.id

label​

readonly label: string

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

Inherited from​

BaseProvider.label

locality​

readonly locality: Locality

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

Inherited from​

BaseProvider.locality

Methods​

createSession()​

createSession(options): Promise<ProviderSession>

Defined in: packages/client/src/providers/server.ts:60

Parameters​

options​

SessionOptions

Returns​

Promise<ProviderSession>

Overrides​

BaseProvider.createSession

detect()​

detect(): Promise<void>

Defined in: packages/client/src/providers/server.ts:52

Check availability. Cheap and safe to call often.

Returns​

Promise<void>

Overrides​

BaseProvider.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

Inherited from​

BaseProvider.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

Inherited from​

BaseProvider.onChange

setState()​

protected setState(patch): void

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

Parameters​

patch​

Partial<ProviderState>

Returns​

void

Inherited from​

BaseProvider.setState