Interface WorkspaceSymbolParams

The parameters of a WorkspaceSymbolRequest.

interface WorkspaceSymbolParams {
    partialResultToken?: ProgressToken;
    query: string;
    workDoneToken?: ProgressToken;
}

Hierarchy (View Summary)

Properties

partialResultToken?: ProgressToken

An optional token that a server can use to report partial results (e.g. streaming) to the client.

query: string

A query string to filter symbols by. Clients may send an empty string here to request all symbols.

The query-parameter should be interpreted in a relaxed way as editors will apply their own highlighting and scoring on the results. A good rule of thumb is to match case-insensitive and to simply check that the characters of query appear in their order in a candidate symbol. Servers shouldn't use prefix, substring, or similar strict matching.

workDoneToken?: ProgressToken

An optional token that a server can use to report work done progress.