UNPKG

2.2 kBTypeScriptView Raw
1import { InlineCompletionItem, InlineCompletionContext, InlineCompletionList } from 'vscode-languageserver-types';
2import { RequestHandler } from 'vscode-jsonrpc';
3import { MessageDirection, ProtocolRequestType } from './messages';
4import type { TextDocumentRegistrationOptions, WorkDoneProgressOptions, StaticRegistrationOptions, WorkDoneProgressParams, TextDocumentPositionParams } from './protocol';
5/**
6 * Client capabilities specific to inline completions.
7 *
8 * @since 3.18.0
9 * @proposed
10 */
11export type InlineCompletionClientCapabilities = {
12 /**
13 * Whether implementation supports dynamic registration for inline completion providers.
14 */
15 dynamicRegistration?: boolean;
16};
17/**
18 * Inline completion options used during static registration.
19 *
20 * @since 3.18.0
21 * @proposed
22 */
23export type InlineCompletionOptions = WorkDoneProgressOptions;
24/**
25 * Inline completion options used during static or dynamic registration.
26 *
27 * @since 3.18.0
28 * @proposed
29 */
30export type InlineCompletionRegistrationOptions = InlineCompletionOptions & TextDocumentRegistrationOptions & StaticRegistrationOptions;
31/**
32 * A parameter literal used in inline completion requests.
33 *
34 * @since 3.18.0
35 * @proposed
36 */
37export type InlineCompletionParams = WorkDoneProgressParams & TextDocumentPositionParams & {
38 /**
39 * Additional information about the context in which inline completions were
40 * requested.
41 */
42 context: InlineCompletionContext;
43};
44/**
45 * A request to provide inline completions in a document. The request's parameter is of
46 * type {@link InlineCompletionParams}, the response is of type
47 * {@link InlineCompletion InlineCompletion[]} or a Thenable that resolves to such.
48 *
49 * @since 3.18.0
50 * @proposed
51 */
52export declare namespace InlineCompletionRequest {
53 const method: 'textDocument/inlineCompletion';
54 const messageDirection: MessageDirection;
55 const type: ProtocolRequestType<InlineCompletionParams, InlineCompletionList | InlineCompletionItem[] | null, InlineCompletionItem[], void, InlineCompletionRegistrationOptions>;
56 type HandlerSignature = RequestHandler<InlineCompletionParams, InlineCompletionList | InlineCompletionItem[] | null, void>;
57}