Class VSCodeLoroProvider

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

Implements

Provider

Index

Constructors

Accessors

Methods

connect disconnect off on

Constructors

constructor

new VSCodeLoroProvider(
    adapterId: string,
    doc: LoroDoc,
    userName: string,
    userColor: string,
    websocketUrl?: string,
): VSCodeLoroProvider
Creates a new VS Code Loro provider instance.
Parameters
- adapterId: string
  Unique adapter identifier for this provider.
- doc: LoroDoc
  Loro document instance for CRDT operations.
- userName: string
  Username for awareness state.
- userColor: string
  User's display color for awareness presence.
- OptionalwebsocketUrl: string
  Optional WebSocket URL for server connection.
Returns VSCodeLoroProvider
- Defined in webview/services/loro/vsCodeLoroProvider.ts:80

Accessors

awareness

get awareness(): AwarenessProvider
Get the awareness provider.

Returns AwarenessProvider
Implementation of Provider.awareness
- Defined in webview/services/loro/vsCodeLoroProvider.ts:143

Methods

connect

connect(): void
Connect to the collaboration server.

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

disconnect

disconnect(): void
Disconnect from the collaboration server.

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

off

off(type: "sync", cb: (isSynced: boolean) => void): void
Unregister event listener for synchronization state changes.
Parameters
- type: "sync"
  Event type 'sync'.
- cb: (isSynced: boolean) => void
  Callback function to remove.
Returns void
Implementation of Provider.off
- Defined in webview/services/loro/vsCodeLoroProvider.ts:236
off(type: "status", cb: (status: { status: string }) => void): void
Unregister event listener for connection status changes.
Parameters
- type: "status"
  Event type 'status'.
- cb: (status: { status: string }) => void
  Callback function to remove.
Returns void
Implementation of Provider.off
- Defined in webview/services/loro/vsCodeLoroProvider.ts:242
off(type: "update", cb: (update: unknown) => void): void
Unregister event listener for remote document updates.
Parameters
- type: "update"
  Event type 'update'.
- cb: (update: unknown) => void
  Callback function to remove.
Returns void
Implementation of Provider.off
- Defined in webview/services/loro/vsCodeLoroProvider.ts:248
off(type: "reload", cb: (doc: LoroDoc) => void): void
Unregister event listener for document reload events.
Parameters
- type: "reload"
  Event type 'reload'.
- cb: (doc: LoroDoc) => void
  Callback function to remove.
Returns void
Implementation of Provider.off
- Defined in webview/services/loro/vsCodeLoroProvider.ts:254

on

on(type: "sync", cb: (isSynced: boolean) => void): void
Register event listener for synchronization state changes.
Parameters
- type: "sync"
  Event type 'sync'.
- cb: (isSynced: boolean) => void
  Callback function receiving sync state.
Returns void
Implementation of Provider.on
- Defined in webview/services/loro/vsCodeLoroProvider.ts:190
on(type: "status", cb: (status: { status: string }) => void): void
Register event listener for connection status changes.
Parameters
- type: "status"
  Event type 'status'.
- cb: (status: { status: string }) => void
  Callback function receiving status object.
Returns void
Implementation of Provider.on
- Defined in webview/services/loro/vsCodeLoroProvider.ts:196
on(type: "update", cb: (update: unknown) => void): void
Register event listener for remote document updates.
Parameters
- type: "update"
  Event type 'update'.
- cb: (update: unknown) => void
  Callback function receiving update data.
Returns void
Implementation of Provider.on
- Defined in webview/services/loro/vsCodeLoroProvider.ts:202
on(type: "reload", cb: (doc: LoroDoc) => void): void
Register event listener for document reload events.
Parameters
- type: "reload"
  Event type 'reload'.
- cb: (doc: LoroDoc) => void
  Callback function receiving reloaded document.
Returns void
Implementation of Provider.on
- Defined in webview/services/loro/vsCodeLoroProvider.ts:208