108 lines
4.1 KiB
Plaintext
108 lines
4.1 KiB
Plaintext
import { NotificationHandler, RequestHandler, ProgressType, ProgressToken } from 'vscode-jsonrpc';
|
|
import { uinteger } from 'vscode-languageserver-types';
|
|
import { MessageDirection, ProtocolRequestType, ProtocolNotificationType } from './messages';
|
|
export interface WorkDoneProgressBegin {
|
|
kind: 'begin';
|
|
/**
|
|
* Mandatory title of the progress operation. Used to briefly inform about
|
|
* the kind of operation being performed.
|
|
*
|
|
* Examples: "Indexing" or "Linking dependencies".
|
|
*/
|
|
title: string;
|
|
/**
|
|
* Controls if a cancel button should show to allow the user to cancel the
|
|
* long running operation. Clients that don't support cancellation are allowed
|
|
* to ignore the setting.
|
|
*/
|
|
cancellable?: boolean;
|
|
/**
|
|
* Optional, more detailed associated progress message. Contains
|
|
* complementary information to the `title`.
|
|
*
|
|
* Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
|
|
* If unset, the previous progress message (if any) is still valid.
|
|
*/
|
|
message?: string;
|
|
/**
|
|
* Optional progress percentage to display (value 100 is considered 100%).
|
|
* If not provided infinite progress is assumed and clients are allowed
|
|
* to ignore the `percentage` value in subsequent in report notifications.
|
|
*
|
|
* The value should be steadily rising. Clients are free to ignore values
|
|
* that are not following this rule. The value range is [0, 100].
|
|
*/
|
|
percentage?: uinteger;
|
|
}
|
|
export interface WorkDoneProgressReport {
|
|
kind: 'report';
|
|
/**
|
|
* Controls enablement state of a cancel button.
|
|
*
|
|
* Clients that don't support cancellation or don't support controlling the button's
|
|
* enablement state are allowed to ignore the property.
|
|
*/
|
|
cancellable?: boolean;
|
|
/**
|
|
* Optional, more detailed associated progress message. Contains
|
|
* complementary information to the `title`.
|
|
*
|
|
* Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
|
|
* If unset, the previous progress message (if any) is still valid.
|
|
*/
|
|
message?: string;
|
|
/**
|
|
* Optional progress percentage to display (value 100 is considered 100%).
|
|
* If not provided infinite progress is assumed and clients are allowed
|
|
* to ignore the `percentage` value in subsequent in report notifications.
|
|
*
|
|
* The value should be steadily rising. Clients are free to ignore values
|
|
* that are not following this rule. The value range is [0, 100]
|
|
*/
|
|
percentage?: uinteger;
|
|
}
|
|
export interface WorkDoneProgressEnd {
|
|
kind: 'end';
|
|
/**
|
|
* Optional, a final message indicating to for example indicate the outcome
|
|
* of the operation.
|
|
*/
|
|
message?: string;
|
|
}
|
|
export declare namespace WorkDoneProgress {
|
|
const type: ProgressType<WorkDoneProgressBegin | WorkDoneProgressReport | WorkDoneProgressEnd>;
|
|
function is(value: ProgressType<any>): value is typeof type;
|
|
}
|
|
export interface WorkDoneProgressCreateParams {
|
|
/**
|
|
* The token to be used to report progress.
|
|
*/
|
|
token: ProgressToken;
|
|
}
|
|
/**
|
|
* The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
|
|
* reporting from the server.
|
|
*/
|
|
export declare namespace WorkDoneProgressCreateRequest {
|
|
const method: 'window/workDoneProgress/create';
|
|
const messageDirection: MessageDirection;
|
|
const type: ProtocolRequestType<WorkDoneProgressCreateParams, void, never, void, void>;
|
|
type HandlerSignature = RequestHandler<WorkDoneProgressCreateParams, void, void>;
|
|
}
|
|
export interface WorkDoneProgressCancelParams {
|
|
/**
|
|
* The token to be used to report progress.
|
|
*/
|
|
token: ProgressToken;
|
|
}
|
|
/**
|
|
* The `window/workDoneProgress/cancel` notification is sent from the client to the server to cancel a progress
|
|
* initiated on the server side.
|
|
*/
|
|
export declare namespace WorkDoneProgressCancelNotification {
|
|
const method: 'window/workDoneProgress/cancel';
|
|
const messageDirection: MessageDirection;
|
|
const type: ProtocolNotificationType<WorkDoneProgressCancelParams, void>;
|
|
type HandlerSignature = NotificationHandler<WorkDoneProgressCancelParams>;
|
|
}
|