Class DesktopLoroProvider

Provider implementation for Desktop Electron environment. Uses IPC to communicate with Main Process's WebSocket adapter.

Implements

Provider

Index

Constructors

constructor

new DesktopLoroProvider(
    adapterId: string,
    doc: LoroDoc,
    userName: string,
    userColor: string,
    websocketUrl?: string,
    token?: string,
): DesktopLoroProvider
Parameters
- adapterId: string
- doc: LoroDoc
- userName: string
- userColor: string
- OptionalwebsocketUrl: string
- Optionaltoken: string
Returns DesktopLoroProvider
- Defined in src/renderer/services/loro/loroProvider.ts:59

Properties

`Private` `Readonly`_awareness

_awareness: AwarenessAdapter

`Private` `Readonly`adapterId

adapterId: string

`Private` `Readonly`doc

doc: LoroDoc

`Private`documentId

documentId: string

`Private` `Readonly`ephemeralStore

ephemeralStore: EphemeralStore

`Private`eventHandler

eventHandler: null | ((event: unknown) => void) = null

`Private`isSynced

isSynced: boolean = false

`Private`reloadListeners

reloadListeners: Set<(doc: LoroDoc) => void> = ...

`Private`statusListeners

statusListeners: Set<(status: { status: string }) => void> = ...

`Private`syncListeners

syncListeners: Set<(isSynced: boolean) => void> = ...

`Private`token

token: string

`Private`updateListeners

updateListeners: Set<(update: unknown) => void> = ...

`Private`websocketUrl

websocketUrl: string

Accessors

awareness

get awareness(): AwarenessProvider
Get the awareness provider

Returns AwarenessProvider
Implementation of Provider.awareness
- Defined in src/renderer/services/loro/loroProvider.ts:118

Methods

connect

connect(): void
Connect to the collaboration server

Returns void
Implementation of Provider.connect
- Defined in src/renderer/services/loro/loroProvider.ts:125

disconnect

disconnect(): void
Disconnect from the collaboration server

Returns void
Implementation of Provider.disconnect
- Defined in src/renderer/services/loro/loroProvider.ts:144

`Private`handleMainProcessMessage

handleMainProcessMessage(messageData: unknown): void
Handle messages from the Main Process
Parameters
- messageData: unknown
Returns void
- Defined in src/renderer/services/loro/loroProvider.ts:210

`Private`handleWebSocketMessage

handleWebSocketMessage(message: WebSocketMessage): void
Handle WebSocket messages
Parameters
- message: WebSocketMessage
Returns void
- Defined in src/renderer/services/loro/loroProvider.ts:278

off

off(type: "sync", cb: (isSynced: boolean) => void): void
Unregister event listener
Parameters
- type: "sync"
- cb: (isSynced: boolean) => void
Returns void
Implementation of Provider.off
- Defined in src/renderer/services/loro/loroProvider.ts:186
off(type: "status", cb: (status: { status: string }) => void): void
Unregister event listener
Parameters
- type: "status"
- cb: (status: { status: string }) => void
Returns void
Implementation of Provider.off
- Defined in src/renderer/services/loro/loroProvider.ts:187
off(type: "update", cb: (update: unknown) => void): void
Unregister event listener
Parameters
- type: "update"
- cb: (update: unknown) => void
Returns void
Implementation of Provider.off
- Defined in src/renderer/services/loro/loroProvider.ts:188
off(type: "reload", cb: (doc: LoroDoc) => void): void
Unregister event listener
Parameters
- type: "reload"
- cb: (doc: LoroDoc) => void
Returns void
Implementation of Provider.off
- Defined in src/renderer/services/loro/loroProvider.ts:189

on

on(type: "sync", cb: (isSynced: boolean) => void): void
Register event listener
Parameters
- type: "sync"
- cb: (isSynced: boolean) => void
Returns void
Implementation of Provider.on
- Defined in src/renderer/services/loro/loroProvider.ts:162
on(type: "status", cb: (status: { status: string }) => void): void
Register event listener
Parameters
- type: "status"
- cb: (status: { status: string }) => void
Returns void
Implementation of Provider.on
- Defined in src/renderer/services/loro/loroProvider.ts:163
on(type: "update", cb: (update: unknown) => void): void
Register event listener
Parameters
- type: "update"
- cb: (update: unknown) => void
Returns void
Implementation of Provider.on
- Defined in src/renderer/services/loro/loroProvider.ts:164
on(type: "reload", cb: (doc: LoroDoc) => void): void
Register event listener
Parameters
- type: "reload"
- cb: (doc: LoroDoc) => void
Returns void
Implementation of Provider.on
- Defined in src/renderer/services/loro/loroProvider.ts:165

`Private`sendToMainProcess

sendToMainProcess(message: LoroMessage): void
Send a message to the Main Process
Parameters
- message: LoroMessage
Returns void
- Defined in src/renderer/services/loro/loroProvider.ts:319

Class DesktopLoroProvider

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DesktopLoroProvider

Properties

Private Readonly_awareness

Private ReadonlyadapterId

Private Readonlydoc

PrivatedocumentId

Private ReadonlyephemeralStore

PrivateeventHandler

PrivateisSynced

PrivatereloadListeners

PrivatestatusListeners

PrivatesyncListeners

Privatetoken

PrivateupdateListeners

PrivatewebsocketUrl

Accessors

awareness

Returns AwarenessProvider

Methods

connect

Returns void

disconnect

Returns void

PrivatehandleMainProcessMessage

Parameters

Returns void

PrivatehandleWebSocketMessage

Parameters

Returns void

off

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

on

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

PrivatesendToMainProcess

Parameters

Returns void

Settings

On This Page

`Private` `Readonly`_awareness

`Private` `Readonly`adapterId

`Private` `Readonly`doc

`Private`documentId

`Private` `Readonly`ephemeralStore

`Private`eventHandler

`Private`isSynced

`Private`reloadListeners

`Private`statusListeners

`Private`syncListeners

`Private`token

`Private`updateListeners

`Private`websocketUrl

`Private`handleMainProcessMessage

`Private`handleWebSocketMessage

`Private`sendToMainProcess