View source

class FileWillCreateEvent

package vscode

@:jsRequire("vscode","FileWillCreateEvent")

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 {@link WorkspaceEdit workspace edit}.

Variables

read onlyfiles:ReadOnlyArray<Uri>

The files that are going to be created.

read onlytoken:CancellationToken

A cancellation token.

Methods

waitUntil(thenable:Thenable<WorkspaceEdit>):Void

waitUntil(thenable:Thenable<Dynamic>):Void

Allows to pause the event and to apply a {@link WorkspaceEdit workspace edit}.

Note: This function can only be called during event dispatch and not in an asynchronous manner:

workspace.onWillCreateFiles(event => {
	// async, will *throw* an error
	setTimeout(() => event.waitUntil(promise));

	// sync, OK
	event.waitUntil(promise);
})

Parameters:

thenable

A thenable that delays saving.