TextDocumentWillSaveEvent class

An event that is fired when a {@link TextDocumentdocument} will be saved.

To make modifications to the document before it is being saved, call the {@linkcode TextDocumentWillSaveEvent.waitUntilwaitUntil}-function with a thenable that resolves to an array of {@link TextEdittext edits}.

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

TextDocumentWillSaveEvent({TextDocument? document, TextDocumentSaveReason? reason})
factory

Properties

document → TextDocument

Available on TextDocumentWillSaveEvent, provided by the TextDocumentWillSaveEvent$Typings extension

The document that will be saved.
no setter
hashCode → int
The hash code for this object.
no setterinherited
reason → TextDocumentSaveReason

Available on TextDocumentWillSaveEvent, provided by the TextDocumentWillSaveEvent$Typings extension

The reason why save was triggered.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
waitUntil → ({void Function(Future thenable) $1, void Function(Future thenable) $2})

Available on TextDocumentWillSaveEvent, provided by the TextDocumentWillSaveEvent$Typings extension

Overload accessor: $1, $2
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited