87 lines
3 KiB
TypeScript
87 lines
3 KiB
TypeScript
|
import { TextDocumentIdentifier, Range, InlineValue, InlineValueContext } from 'vscode-languageserver-types';
|
||
|
|
import { RequestHandler, RequestHandler0 } from 'vscode-jsonrpc';
|
||
|
|
import { MessageDirection, ProtocolRequestType, ProtocolRequestType0 } from './messages';
|
||
|
|
import type { TextDocumentRegistrationOptions, WorkDoneProgressOptions, StaticRegistrationOptions, WorkDoneProgressParams } from './protocol';
|
||
|
|
/**
|
||
|
|
* Client capabilities specific to inline values.
|
||
|
|
*
|
||
|
|
* @since 3.17.0
|
||
|
|
*/
|
||
|
|
export declare type InlineValueClientCapabilities = {
|
||
|
|
/**
|
||
|
|
* Whether implementation supports dynamic registration for inline value providers.
|
||
|
|
*/
|
||
|
|
dynamicRegistration?: boolean;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* Client workspace capabilities specific to inline values.
|
||
|
|
*
|
||
|
|
* @since 3.17.0
|
||
|
|
*/
|
||
|
|
export declare type InlineValueWorkspaceClientCapabilities = {
|
||
|
|
/**
|
||
|
|
* Whether the client implementation supports a refresh request sent from the
|
||
|
|
* server to the client.
|
||
|
|
*
|
||
|
|
* Note that this event is global and will force the client to refresh all
|
||
|
|
* inline values currently shown. It should be used with absolute care and is
|
||
|
|
* useful for situation where a server for example detects a project wide
|
||
|
|
* change that requires such a calculation.
|
||
|
|
*/
|
||
|
|
refreshSupport?: boolean;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* Inline value options used during static registration.
|
||
|
|
*
|
||
|
|
* @since 3.17.0
|
||
|
|
*/
|
||
|
|
export declare type InlineValueOptions = WorkDoneProgressOptions;
|
||
|
|
/**
|
||
|
|
* Inline value options used during static or dynamic registration.
|
||
|
|
*
|
||
|
|
* @since 3.17.0
|
||
|
|
*/
|
||
|
|
export declare type InlineValueRegistrationOptions = InlineValueOptions & TextDocumentRegistrationOptions & StaticRegistrationOptions;
|
||
|
|
/**
|
||
|
|
* A parameter literal used in inline value requests.
|
||
|
|
*
|
||
|
|
* @since 3.17.0
|
||
|
|
*/
|
||
|
|
export declare type InlineValueParams = WorkDoneProgressParams & {
|
||
|
|
/**
|
||
|
|
* The text document.
|
||
|
|
*/
|
||
|
|
textDocument: TextDocumentIdentifier;
|
||
|
|
/**
|
||
|
|
* The document range for which inline values should be computed.
|
||
|
|
*/
|
||
|
|
range: Range;
|
||
|
|
/**
|
||
|
|
* Additional information about the context in which inline values were
|
||
|
|
* requested.
|
||
|
|
*/
|
||
|
|
context: InlineValueContext;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* A request to provide inline values in a document. The request's parameter is of
|
||
|
|
* type {@link InlineValueParams}, the response is of type
|
||
|
|
* {@link InlineValue InlineValue[]} or a Thenable that resolves to such.
|
||
|
|
*
|
||
|
|
* @since 3.17.0
|
||
|
|
*/
|
||
|
|
export declare namespace InlineValueRequest {
|
||
|
|
const method: 'textDocument/inlineValue';
|
||
|
|
const messageDirection: MessageDirection;
|
||
|
|
const type: ProtocolRequestType<InlineValueParams, InlineValue[] | null, InlineValue[], void, InlineValueRegistrationOptions>;
|
||
|
|
type HandlerSignature = RequestHandler<InlineValueParams, InlineValue[] | null, void>;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* @since 3.17.0
|
||
|
|
*/
|
||
|
|
export declare namespace InlineValueRefreshRequest {
|
||
|
|
const method: `workspace/inlineValue/refresh`;
|
||
|
|
const messageDirection: MessageDirection;
|
||
|
|
const type: ProtocolRequestType0<void, void, void, void>;
|
||
|
|
type HandlerSignature = RequestHandler0<void, void>;
|
||
|
|
}
|