atom-languageclient/build/lib/adapters/show-document-adapter.d.ts

Integrate Language Servers with Atom

import { LanguageClientConnection, ShowDocumentParams, ShowDocumentResult } from "../languageclient";
/** Public: Adapts the window/showDocument command to Atom's text editors or external programs. */
declare const ShowDocumentAdapter: {
    /** {@inheritDoc attach} */
    attach: typeof attach;
    /** {@inheritDoc showDocument} */
    showDocument: typeof showDocument;
};
export default ShowDocumentAdapter;
/** Public: Attach to a {LanguageClientConnection} to recieve requests to show documents. */
export declare function attach(connection: LanguageClientConnection): void;
/**
 * Public: show documents inside Atom text editor or in external programs
 *
 * @param params The {ShowDocumentParams} received from the language server indicating the document to be displayed as
 *   well as other metadata.
 * @returns {Promise<ShowDocumentResult>} With a `success: boolean` property specifying if the operation was sucessful
 *   {@inheritDoc ShowDocumentParams}
 */
export declare function showDocument(params: ShowDocumentParams): Promise<ShowDocumentResult>;