Interface ILSPConnectionAlpha

Interface describing he connection to the language server.

interface ILSPConnection {
    clientNotifications: ClientNotifications<keyof IClientNotifyParams>;
    clientRequests: ClientRequests<keyof IClientRequestParams>;
    closeSignal: ISignal<ILSPConnection, boolean>;
    disposed: ISignal<ILSPConnection, void>;
    errorSignal: ISignal<ILSPConnection, any>;
    isConnected: boolean;
    isDisposed: boolean;
    isInitialized: boolean;
    isReady: boolean;
    logAllCommunication: boolean;
    serverCapabilities: ServerCapabilities<any>;
    serverIdentifier?: string;
    serverInitialized: ISignal<ILSPConnection, ServerCapabilities<any>>;
    serverLanguage?: string;
    serverNotifications: ServerNotifications<keyof IServerNotifyParams>;
    serverRequests: ServerRequests<keyof IServerRequestParams>;
    close(): void;
    connect(socket: WebSocket): void;
    dispose(): void;
    provides(capability: keyof ServerCapabilities<any>): boolean;
    sendChange(documentInfo: IDocumentInfo): void;
    sendConfigurationChange(settings: DidChangeConfigurationParams): void;
    sendFullTextChange(text: string, documentInfo: IDocumentInfo): void;
    sendInitialize(): void;
    sendOpen(documentInfo: IDocumentInfo): void;
    sendOpenWhenReady(documentInfo: IDocumentInfo): void;
    sendSaved(documentInfo: IDocumentInfo): void;
}

Hierarchy

Properties

clientNotifications clientRequests closeSignal disposed errorSignal isConnected isDisposed isInitialized isReady logAllCommunication serverCapabilities serverIdentifier? serverInitialized serverLanguage? serverNotifications serverRequests

Methods

close connect dispose provides sendChange sendConfigurationChange sendFullTextChange sendInitialize sendOpen sendOpenWhenReady sendSaved

Properties

AlphaclientNotifications

clientNotifications: ClientNotifications<keyof IClientNotifyParams>

Notifications that come from the client.

AlphaclientRequests

clientRequests: ClientRequests<keyof IClientRequestParams>

Requests that come from the client.

AlphacloseSignal

closeSignal: ISignal<ILSPConnection, boolean>

Signal emitted when the connection is closed.

Readonly Alphadisposed

disposed: ISignal<ILSPConnection, void>

A signal emitted when the object is disposed.

AlphaerrorSignal

errorSignal: ISignal<ILSPConnection, any>

Signal emitted when the connection receives an error message..

AlphaisConnected

isConnected: boolean

Is the language server is connected?

Readonly AlphaisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

AlphaisInitialized

isInitialized: boolean

Is the language server is initialized?

AlphaisReady

isReady: boolean

Is the language server is connected and initialized?

AlphalogAllCommunication

logAllCommunication: boolean

Should log all communication?

AlphaserverCapabilities

serverCapabilities: ServerCapabilities<any>

Lists server capabilities.

Optional AlphaserverIdentifier

serverIdentifier?: string

Identifier of the language server

AlphaserverInitialized

serverInitialized: ISignal<ILSPConnection, ServerCapabilities<any>>

Signal emitted when the connection is initialized.

Optional AlphaserverLanguage

serverLanguage?: string

Language of the language server

AlphaserverNotifications

serverNotifications: ServerNotifications<keyof IServerNotifyParams>

Notifications that come from the server.

AlphaserverRequests

serverRequests: ServerRequests<keyof IServerRequestParams>

Responses that come from the server.

Methods

close

connect

dispose

  • dispose(): void
  • Alpha

    Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

provides

  • provides(capability: keyof ServerCapabilities<any>): boolean
  • Alpha

    Check if a capability is available in the server capabilities.

    Parameters

    • capability: keyof ServerCapabilities<any>

    Returns boolean

sendChange

sendConfigurationChange

  • sendConfigurationChange(settings: DidChangeConfigurationParams): void
  • Alpha

    Send configuration change to the server.

    Parameters

    • settings: DidChangeConfigurationParams

    Returns void

sendFullTextChange

sendInitialize

  • sendInitialize(): void
  • Alpha

    The initialize request tells the server which options the client supports

    Returns void

sendOpen

sendOpenWhenReady

sendSaved

Settings

Member Visibility

On This Page

Properties
Methods