Class VSCodeLoroProvider

Provider implementation for VS Code environment. Uses postMessage to communicate with extension's WebSocket adapter.

Implements

Provider

Index

Constructors

Constructors

constructor

new VSCodeLoroProvider(
    adapterId: string,
    doc: LoroDoc,
    userName: string,
    userColor: string,
    websocketUrl?: string,
): VSCodeLoroProvider
Parameters
- adapterId: string
- doc: LoroDoc
- userName: string
- userColor: string
- OptionalwebsocketUrl: string
Returns VSCodeLoroProvider
- Defined in webview/services/loro/vsCodeLoroProvider.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`isSynced

isSynced: boolean = false

`Private`messageDisposable

messageDisposable: Disposable = null

`Private`reloadListeners

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

`Private`statusListeners

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

`Private`syncListeners

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

`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 webview/services/loro/vsCodeLoroProvider.ts:122

Methods

connect

connect(): void
Connect to the collaboration server

Returns void
Implementation of Provider.connect
- Defined in webview/services/loro/vsCodeLoroProvider.ts:129

disconnect

disconnect(): void
Disconnect from the collaboration server

Returns void
Implementation of Provider.disconnect
- Defined in webview/services/loro/vsCodeLoroProvider.ts:149

`Private`handleExtensionMessage

handleExtensionMessage(messageData: unknown): void
Handle messages from the extension
Parameters
- messageData: unknown
Returns void
- Defined in webview/services/loro/vsCodeLoroProvider.ts:215

`Private`handleWebSocketMessage

handleWebSocketMessage(message: WebSocketMessage): void
Handle WebSocket messages
Parameters
- message: WebSocketMessage
Returns void
- Defined in webview/services/loro/vsCodeLoroProvider.ts:283

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 webview/services/loro/vsCodeLoroProvider.ts:191
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 webview/services/loro/vsCodeLoroProvider.ts:192
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 webview/services/loro/vsCodeLoroProvider.ts:193
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 webview/services/loro/vsCodeLoroProvider.ts:194

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 webview/services/loro/vsCodeLoroProvider.ts:167
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 webview/services/loro/vsCodeLoroProvider.ts:168
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 webview/services/loro/vsCodeLoroProvider.ts:169
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 webview/services/loro/vsCodeLoroProvider.ts:170

`Private`sendToExtension

sendToExtension(message: LoroMessage): void
Send a message to the extension
Parameters
- message: LoroMessage
Returns void
- Defined in webview/services/loro/vsCodeLoroProvider.ts:326

Class VSCodeLoroProvider

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns VSCodeLoroProvider

Properties

Private Readonly_awareness

Private ReadonlyadapterId

Private Readonlydoc

PrivatedocumentId

Private ReadonlyephemeralStore

PrivateisSynced

PrivatemessageDisposable

PrivatereloadListeners

PrivatestatusListeners

PrivatesyncListeners

PrivateupdateListeners

PrivatewebsocketUrl

Accessors

awareness

Returns AwarenessProvider

Methods

connect

Returns void

disconnect

Returns void

PrivatehandleExtensionMessage

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

PrivatesendToExtension

Parameters

Returns void

Settings

On This Page

`Private` `Readonly`_awareness

`Private` `Readonly`adapterId

`Private` `Readonly`doc

`Private`documentId

`Private` `Readonly`ephemeralStore

`Private`isSynced

`Private`messageDisposable

`Private`reloadListeners

`Private`statusListeners

`Private`syncListeners

`Private`updateListeners

`Private`websocketUrl

`Private`handleExtensionMessage

`Private`handleWebSocketMessage

`Private`sendToExtension