Readonly
notebookThe notebook document that will be saved.
Readonly
reasonThe reason why save was triggered.
Readonly
tokenA cancellation token.
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);
})
A thenable that resolves to workspace edit.
Allows to pause the event loop until the provided thenable resolved.
Note: This function can only be called during event dispatch.
A thenable that delays saving.
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.