Interface FakeWebviews

In-memory webview capability for tests.

interface FakeWebviews {
    panels: readonly FakeWebviewPanel[];
    serializers: readonly FakeWebviewSerializer[];
    views: readonly FakeWebviewView[];
    _addFile(path: string, contents: string): void;
    createPanel(request: WebviewPanelRequest): WebviewPanelSurface;
    readExtensionFile(extensionRelativePath: string): Promise<string>;
    registerPanelSerializer(
        viewType: string,
        restore: (
            surface: WebviewPanelSurface,
            state: unknown,
        ) => void | Promise<void>,
    ): PlatformRegistration;
    registerViewProvider(
        viewId: string,
        resolve: (surface: WebviewViewSurface) => void | Promise<void>,
        options: WebviewViewRequest,
    ): PlatformRegistration;
}

Hierarchy

WebviewCapability
- FakeWebviews

Index

Properties

panels serializers views

Methods

_addFile createPanel readExtensionFile registerPanelSerializer registerViewProvider

Properties

`Readonly`panels

panels: readonly FakeWebviewPanel[]

Every panel opened, in order, including closed ones.

`Readonly`serializers

serializers: readonly FakeWebviewSerializer[]

Every panel restorer registered, in order.

`Readonly`views

views: readonly FakeWebviewView[]

Every view provider registered, in order.

Methods

_addFile

_addFile(path: string, contents: string): void
Adds a file the extension can read as a template.
Parameters
- path: string
- contents: string
Returns void
- Defined in src/testing/fakes/fake-webview.ts:84

createPanel

createPanel(request: WebviewPanelRequest): WebviewPanelSurface
Opens a panel. The caller owns the surface and must eventually dispose it.
Parameters
- request: WebviewPanelRequest
Returns WebviewPanelSurface
Inherited from WebviewCapability.createPanel
- Defined in src/foundation/platform/ports.ts:862

readExtensionFile

readExtensionFile(extensionRelativePath: string): Promise<string>
Reads a file shipped with the extension, as text.

Goes through the platform rather than Node's fs so templates load in remote and web extension hosts too.
Parameters
- extensionRelativePath: string
Returns Promise<string>
Inherited from WebviewCapability.readExtensionFile
- Defined in src/foundation/platform/ports.ts:893

registerPanelSerializer

registerPanelSerializer(
    viewType: string,
    restore: (
        surface: WebviewPanelSurface,
        state: unknown,
    ) => void | Promise<void>,
): PlatformRegistration
Registers the restorer for a panel of viewType.

Called when a window reopens with a panel of this kind still in its tab layout. Without one, the tab is discarded on reload -- so this is what makes a panel survive a window restart, not an optimisation. The returned registration is Application-owned and must be disposed on shutdown.
Parameters
- viewType: string
- restore: (surface: WebviewPanelSurface, state: unknown) => void | Promise<void>
Returns PlatformRegistration
Inherited from WebviewCapability.registerPanelSerializer
- Defined in src/foundation/platform/ports.ts:883

registerViewProvider

registerViewProvider(
    viewId: string,
    resolve: (surface: WebviewViewSurface) => void | Promise<void>,
    options: WebviewViewRequest,
): PlatformRegistration
Registers the provider for a view contributed in package.json. The callback runs when the platform resolves an incarnation of the view and runs again for each later one. Disposing the returned registration prevents future resolves; the surfaces already handed out live until their own onDidDispose.
Parameters
- viewId: string
- resolve: (surface: WebviewViewSurface) => void | Promise<void>
- options: WebviewViewRequest
Returns PlatformRegistration
Inherited from WebviewCapability.registerViewProvider
- Defined in src/foundation/platform/ports.ts:870