kotlin-vscode/vscode/FileWillCreateEvent

FileWillCreateEvent

interface FileWillCreateEvent(source)

An event that is fired when files are going to be created.

To make modifications to the workspace before the files are created, call the {@linkcode FileWillCreateEvent.waitUntil waitUntil}-function with a thenable that resolves to a workspace edit.

Online Documentation

Properties

Link copied to clipboard
abstract val files: ReadonlyArray<Uri>

The files that are going to be created.

Link copied to clipboard
abstract val token: CancellationToken

A cancellation token.

Functions

Link copied to clipboard
abstract fun waitUntil(thenable: PromiseLike<JsAny?>)

Allows to pause the event until the provided thenable resolves.

abstract fun waitUntil(thenable: PromiseLike<WorkspaceEdit>)

Allows to pause the event and to apply a workspace edit.