Liking cljdoc? Tell your friends :D
ClojureScript only.

dots.vscode.file-will-rename-event

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

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

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

To make modifications to the workspace before the files are renamed,
call the {@link FileWillCreateEvent.waitUntil `waitUntil`}-function with a
thenable that resolves to a {@link WorkspaceEdit workspace edit}.
raw docstring

filescljs

(files file-will-rename-event)

The files that are going to be renamed.

Returns: readonly { readonly oldUri: Uri; readonly newUri: Uri; }[]

The files that are going to be renamed.

**Returns:** `readonly { readonly oldUri: Uri; readonly newUri: Uri; }[]`
sourceraw docstring

tokencljs

(token file-will-rename-event)

A cancellation token.

Returns: CancellationToken

A cancellation token.

**Returns:** `CancellationToken`
sourceraw docstring

wait-untilcljs

(wait-until file-will-rename-event thenable)

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);
})

Allows to pause the event until the provided thenable resolves.

Note: This function can only be called during event dispatch.

Parameters:

  • thenable: Thenable<any> - A thenable that delays saving.

Returns: 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:

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

	// sync, OK
	event.waitUntil(promise);
})
```
Allows to pause the event until the provided thenable resolves.

*Note:* This function can only be called during event dispatch.

**Parameters:**
- `thenable`: `Thenable<any>` - A thenable that delays saving.

**Returns:** `void`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close