Interface NotebookDocumentWillSaveEvent

An event that is fired when a notebook document will be saved.

To make modifications to the document before it is being saved, call the waitUntil-function with a thenable that resolves to a workspace edit.

interface NotebookDocumentWillSaveEvent {
    notebook: NotebookDocument;
    reason: TextDocumentSaveReason;
    token: CancellationToken;
    waitUntil(thenable): void;
    waitUntil(thenable): void;
}

Properties

Methods

Properties

The notebook document that will be saved.

Stubbed

The reason why save was triggered.

Stubbed

A cancellation token.

Methods

  • Allows to pause the event loop and to apply workspace edit. Edits of subsequent calls to this function will be applied in order. The edits will be ignored if concurrent modifications of the notebook document happened.

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

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

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

    Parameters

    Returns void

    Stubbed

  • Allows to pause the event loop until the provided thenable resolved.

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

    Parameters

    • thenable: Thenable<any>

      A thenable that delays saving.

    Returns void

    Stubbed