External module "workspaces/index"

Index

Enumerations

WorkspaceWatcherEvent

Classes

WorkspaceBase

Interfaces

Type aliases

Functions

registerWorkspaceWatcher

Type aliases

WorkspaceWatcher

WorkspaceWatcher: function

A workspace watcher.

param: The event.
param: The underlying folder.
param: The workspace to remove.

Type declaration

- (event: WorkspaceWatcherEvent, folder: vscode.WorkspaceFolder, workspace?: TWorkspace): WorkspaceWatcherResult<TWorkspace> | PromiseLike<WorkspaceWatcherResult>
- Parameters
  - event: WorkspaceWatcherEvent
  - folder: vscode.WorkspaceFolder
  - Optional workspace: TWorkspace
  Returns WorkspaceWatcherResult<TWorkspace> | PromiseLike<WorkspaceWatcherResult>

WorkspaceWatcherCompleteAction

WorkspaceWatcherCompleteAction: function

A workspace watcher 'complete action'.

param: The error (if occurred).
param: The event.
param: The underlying folder.
param: The workspace to remove.

Type declaration

- (err: any, event: WorkspaceWatcherEvent, folder: vscode.WorkspaceFolder, workspace?: TWorkspace): void | PromiseLike<void>
- Parameters
  - err: any
  - event: WorkspaceWatcherEvent
  - folder: vscode.WorkspaceFolder
  - Optional workspace: TWorkspace
  Returns void | PromiseLike<void>

WorkspaceWatcherResult

WorkspaceWatcherResult: TWorkspace | void | null | undefined

Possible results of a workspace watcher.

Functions

registerWorkspaceWatcher

registerWorkspaceWatcher<TWorkspace>(extension: vscode.ExtensionContext, watcher: WorkspaceWatcher<TWorkspace>, complete?: WorkspaceWatcherCompleteAction<TWorkspace>): WorkspaceWatcherContext<TWorkspace>

- Defined in workspaces/index.ts:176
Registers a workspace watcher.

Type parameters
- TWorkspace: Workspace
Parameters
- extension: vscode.ExtensionContext
  
  The underlying extension (context).
- watcher: WorkspaceWatcher<TWorkspace>
  
  The watcher.
- Optional complete: WorkspaceWatcherCompleteAction<TWorkspace>
Returns WorkspaceWatcherContext<TWorkspace>

The watcher context.

Generated using TypeDoc