Skip to main content

Interface: Provider

@lexical/yjs.Provider

Properties

awareness

awareness: ProviderAwareness

Defined in

lexical-yjs/src/index.ts:35

Methods

connect

connect(): void | Promise<void>

Returns

void | Promise<void>

Defined in

lexical-yjs/src/index.ts:36


disconnect

disconnect(): void

Returns

void

Defined in

lexical-yjs/src/index.ts:37


off

off(type, cb): void

Parameters

NameType
type"sync"
cb(isSynced: boolean) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:38

off(type, cb): void

Parameters

NameType
type"update"
cb(arg0: unknown) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:39

off(type, cb): void

Parameters

NameType
type"status"
cb(arg0: { status: string }) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:40

off(type, cb): void

Parameters

NameType
type"reload"
cb(doc: Doc) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:41


on

on(type, cb): void

Parameters

NameType
type"sync"
cb(isSynced: boolean) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:42

on(type, cb): void

Parameters

NameType
type"status"
cb(arg0: { status: string }) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:43

on(type, cb): void

Parameters

NameType
type"update"
cb(arg0: unknown) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:44

on(type, cb): void

Parameters

NameType
type"reload"
cb(doc: Doc) => void

Returns

void

Defined in

lexical-yjs/src/index.ts:45