Logo fantomas

FantomasService Type

Instance members

Instance member Description

this.ClearCache

Full Usage: this.ClearCache

Modifiers: abstract

this.ConfigurationAsync

Full Usage: this.ConfigurationAsync

Parameters:
Returns: Task<FantomasResponse>
Modifiers: abstract
filePath : string
?cancellationToken : CancellationToken
Returns: Task<FantomasResponse>

this.ConfigurationWarnings

Full Usage: this.ConfigurationWarnings

Returns: IEvent<ConfigurationWarning>
Modifiers: abstract

Raised for every format request, with the settings in the resolved configuration that Fantomas could not act on. Raised with an empty `Problems` list when there is nothing wrong, so a subscriber can clear what it reported earlier, and raised before the request it belongs to answers. Raised on whichever thread the daemon's answer arrived on, never on the caller's. A subscriber that touches a UI has to marshal, and one that throws is swallowed rather than allowed to fault the connection. Warnings for one file arrive in the order the requests for it were made, however many of them you have in flight: the daemon serves one request at a time per file. That is what makes the clearing rule sound, so an empty one never overtakes problems that are still current. Requests for different files are served concurrently and their warnings interleave freely. `FilePath` is what tells them apart. Only Fantomas 8 daemons send these; an older one never raises it, so no version check is needed. `Version` names the daemon that raised the warning, so reporting one needs no separate `VersionAsync` call. Asking afterwards would also be a race against `ClearCache`, which can leave a newly installed daemon answering for a warning the one it replaced raised.

Returns: IEvent<ConfigurationWarning>

this.FormatDocumentAsync

Full Usage: this.FormatDocumentAsync

Parameters:
Returns: Task<FantomasResponse>
Modifiers: abstract
arg0 : FormatDocumentRequest
?cancellationToken : CancellationToken
Returns: Task<FantomasResponse>

this.FormatSelectionAsync

Full Usage: this.FormatSelectionAsync

Parameters:
Returns: Task<FantomasResponse>
Modifiers: abstract
arg0 : FormatSelectionRequest
?cancellationToken : CancellationToken
Returns: Task<FantomasResponse>

this.VersionAsync

Full Usage: this.VersionAsync

Parameters:
Returns: Task<FantomasResponse>
Modifiers: abstract
filePath : string
?cancellationToken : CancellationToken
Returns: Task<FantomasResponse>

Type something to start searching.