Class BaseDocumentProvider<TDocument>`Abstract`

Abstract base class for document providers. Handles common provider patterns including webview lifecycle, message routing, and request/response.

Type Parameters

TDocument extends vscode.CustomDocument
The document type (NotebookDocument or LexicalDocument)

Hierarchy (View Summary)

BaseDocumentProvider
- LexicalProvider
- NotebookProvider

Implements

CustomEditorProvider<TDocument>

Constructors

constructor

new BaseDocumentProvider<TDocument extends CustomDocument>(
context: ExtensionContext,
): BaseDocumentProvider<TDocument>
Creates a new base document provider.
Type Parameters
- TDocument extends CustomDocument
Parameters
- context: ExtensionContext
  Extension context
Returns BaseDocumentProvider<TDocument>
- Defined in src/providers/baseDocumentProvider.ts:91

Properties

`Protected` `Readonly`_callbacks

_callbacks: Map<string | number, (response: unknown) => void> = ...

Map of request ID to response callbacks for request/response message pattern.

`Protected` `Readonly`_context

_context: ExtensionContext

VS Code extension context providing access to storage, subscriptions, etc.

`Protected` `Readonly`_messageRouter

_messageRouter: DocumentMessageRouter

Message router for handling webview messages and routing to appropriate handlers.

`Protected` `Readonly`_networkBridge

_networkBridge: NetworkBridgeService

Network bridge service for HTTP/WebSocket communication between extension and webview.

`Protected` `Readonly`_onDidChangeCustomDocument

_onDidChangeCustomDocument: EventEmitter<CustomDocumentEditEvent<TDocument>> = ...

Event emitter for document changes. Subclasses should fire this event when documents change.

`Private`_requestId

_requestId: number = 1

Counter for generating unique request IDs in request/response pattern.

`Protected` `Readonly`_runners

_runners: Map<WebviewPanel, Runner> = ...

Map of webview panels to their Runner instances. Runners handle tool execution via the BridgeExecutor pattern.

`Protected` `Readonly`_runtimeBridge

_runtimeBridge: RuntimeBridgeService

Runtime bridge service for managing runtime lifecycle and selection.

`Readonly`onDidChangeCustomDocument

onDidChangeCustomDocument: Event<CustomDocumentEditEvent<TDocument>> = ...

Event for document changes (required by CustomEditorProvider interface).

Methods

backupCustomDocument

backupCustomDocument(
    _document: TDocument,
    _context: CustomDocumentBackupContext,
    _cancellation: CancellationToken,
): Thenable<CustomDocumentBackup>
Backs up the document. Default implementation throws - subclasses should override if needed.
Parameters
- _document: TDocument
  Document to backup
- _context: CustomDocumentBackupContext
  Backup context
- _cancellation: CancellationToken
  Cancellation token
Returns Thenable<CustomDocumentBackup>
Promise resolving to backup information
Implementation of vscode.CustomEditorProvider.backupCustomDocument
- Defined in src/providers/baseDocumentProvider.ts:196

`Protected` `Abstract`getDocumentUri

getDocumentUri(document: TDocument): Uri
Gets the URI for a document. Subclasses must implement this to extract the URI from their document type.
Parameters
- document: TDocument
  The document
Returns Uri
The document URI
- Defined in src/providers/baseDocumentProvider.ts:389

`Protected`getRunnerForWebview

getRunnerForWebview(webviewPanel: WebviewPanel): Runner
Gets the Runner for a specific webview panel.
Parameters
- webviewPanel: WebviewPanel
  The webview panel
Returns Runner
The Runner instance, or undefined if not initialized
- Defined in src/providers/baseDocumentProvider.ts:250

`Protected`initializeRunnerForWebview

initializeRunnerForWebview(webviewPanel: WebviewPanel): Runner
Initializes a Runner for a webview panel. Subclasses should call this in their resolveCustomEditor implementation.

The Runner uses a BridgeExecutor to send tool execution requests to the webview, where they are executed by the webview's own Runner with DefaultExecutor.
Parameters
- webviewPanel: WebviewPanel
  The webview panel to create a Runner for
Returns Runner
The created Runner instance
Example
```
async resolveCustomEditor(document, webviewPanel, token) {
  // Initialize Runner for this webview
  this.initializeRunnerForWebview(webviewPanel);

  // ... rest of setup
}
```
- Defined in src/providers/baseDocumentProvider.ts:225

`Protected`onMessage

onMessage(
    webviewPanel: WebviewPanel,
    document: TDocument,
    message: ExtensionMessage,
): Promise<void>
Handles messages received from the webview. Delegates to the message router for all message types.
Parameters
- webviewPanel: WebviewPanel
  The webview panel that sent the message
- document: TDocument
  The document associated with the webview
- message: ExtensionMessage
  The message from the webview
Returns Promise<void>
- Defined in src/providers/baseDocumentProvider.ts:365

`Abstract`openCustomDocument

openCustomDocument(
    uri: Uri,
    openContext: { backupId?: string },
    token: CancellationToken,
): Promise<TDocument>
Opens a custom document. Subclasses must implement document creation logic.
Parameters
- uri: Uri
  Document URI
- openContext: { backupId?: string }
  Open context with backup information
- token: CancellationToken
  Cancellation token
Returns Promise<TDocument>
Promise resolving to the document
Implementation of vscode.CustomEditorProvider.openCustomDocument
- Defined in src/providers/baseDocumentProvider.ts:119

`Protected`postMessage

postMessage(panel: WebviewPanel, type: string, body: unknown, id?: string): void
Posts a message to the webview without expecting a response.
Parameters
- panel: WebviewPanel
  Target webview panel
- type: string
  Message type
- body: unknown
  Message body
- Optionalid: string
  Optional message ID
Returns void
- Defined in src/providers/baseDocumentProvider.ts:286

`Protected`postMessageWithResponse

postMessageWithResponse<R = unknown>(
    panel: WebviewPanel,
    type: string,
    body: unknown,
): Promise<R>
Posts a message to the webview and waits for a response. Uses the request/response pattern with requestId tracking.
Type Parameters
- R = unknown
Parameters
- panel: WebviewPanel
  Target webview panel
- type: string
  Message type
- body: unknown
  Message body
Returns Promise<R>
Promise resolving to the response
- Defined in src/providers/baseDocumentProvider.ts:265

`Protected`registerMessageHandlers

registerMessageHandlers(): void
Registers all message handlers with the message router. Called during constructor initialization. Subclasses can override to add custom handlers.

Returns void
- Defined in src/providers/baseDocumentProvider.ts:300

`Abstract`resolveCustomEditor

resolveCustomEditor(
    document: TDocument,
    webviewPanel: WebviewPanel,
    token: CancellationToken,
): Promise<void>
Resolves a custom editor for a document. Subclasses must implement webview setup logic.
Parameters
- document: TDocument
  The document to display
- webviewPanel: WebviewPanel
  The webview panel to use
- token: CancellationToken
  Cancellation token
Returns Promise<void>
Promise that resolves when editor is ready
Implementation of vscode.CustomEditorProvider.resolveCustomEditor
- Defined in src/providers/baseDocumentProvider.ts:134

revertCustomDocument

revertCustomDocument(
_document: TDocument,
_cancellation: CancellationToken,
): Thenable<void>
Reverts the document to its saved state. Default implementation throws - subclasses should override if needed.
Parameters
- _document: TDocument
  Document to revert
- _cancellation: CancellationToken
  Cancellation token
Returns Thenable<void>
Promise that resolves when revert is complete
Implementation of vscode.CustomEditorProvider.revertCustomDocument
- Defined in src/providers/baseDocumentProvider.ts:180

saveCustomDocument

saveCustomDocument(
_document: TDocument,
_cancellation: CancellationToken,
): Thenable<void>
Saves the document. Default implementation throws - subclasses should override if saving is supported.
Parameters
- _document: TDocument
  Document to save
- _cancellation: CancellationToken
  Cancellation token
Returns Thenable<void>
Promise that resolves when save is complete
Implementation of vscode.CustomEditorProvider.saveCustomDocument
- Defined in src/providers/baseDocumentProvider.ts:148

saveCustomDocumentAs

saveCustomDocumentAs(
    _document: TDocument,
    _destination: Uri,
    _cancellation: CancellationToken,
): Thenable<void>
Saves the document to a new location. Default implementation throws - subclasses should override if needed.
Parameters
- _document: TDocument
  Document to save
- _destination: Uri
  Destination URI
- _cancellation: CancellationToken
  Cancellation token
Returns Thenable<void>
Promise that resolves when save is complete
Implementation of vscode.CustomEditorProvider.saveCustomDocumentAs
- Defined in src/providers/baseDocumentProvider.ts:164

Class BaseDocumentProvider<TDocument>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseDocumentProvider<TDocument>

Properties

Protected Readonly_callbacks

Protected Readonly_context

Protected Readonly_messageRouter

Protected Readonly_networkBridge

Protected Readonly_onDidChangeCustomDocument

Private_requestId

Protected Readonly_runners

Protected Readonly_runtimeBridge

ReadonlyonDidChangeCustomDocument

Methods

backupCustomDocument

Parameters

Returns Thenable<CustomDocumentBackup>

Protected AbstractgetDocumentUri

Parameters

Returns Uri

ProtectedgetRunnerForWebview

Parameters

Returns Runner

ProtectedinitializeRunnerForWebview

Parameters

Returns Runner

Example

ProtectedonMessage

Parameters

Returns Promise<void>

AbstractopenCustomDocument

Parameters

Returns Promise<TDocument>

ProtectedpostMessage

Parameters

Returns void

ProtectedpostMessageWithResponse

Type Parameters

Parameters

Returns Promise<R>

ProtectedregisterMessageHandlers

Returns void

AbstractresolveCustomEditor

Parameters

Returns Promise<void>

revertCustomDocument

Parameters

Returns Thenable<void>

saveCustomDocument

Parameters

Returns Thenable<void>

saveCustomDocumentAs

Parameters

Returns Thenable<void>

Settings

On This Page

Class BaseDocumentProvider<TDocument>`Abstract`

`Protected` `Readonly`_callbacks

`Protected` `Readonly`_context

`Protected` `Readonly`_messageRouter

`Protected` `Readonly`_networkBridge

`Protected` `Readonly`_onDidChangeCustomDocument

`Private`_requestId

`Protected` `Readonly`_runners

`Protected` `Readonly`_runtimeBridge

`Readonly`onDidChangeCustomDocument

`Protected` `Abstract`getDocumentUri

`Protected`getRunnerForWebview

`Protected`initializeRunnerForWebview

`Protected`onMessage

`Abstract`openCustomDocument

`Protected`postMessage

`Protected`postMessageWithResponse

`Protected`registerMessageHandlers

`Abstract`resolveCustomEditor