Interface SearchInWorkspaceServer

interface SearchInWorkspaceServer {
    cancel(searchId): Promise<void>;
    dispose(): void;
    search(what, rootUris, opts?): Promise<number>;
}

Hierarchy

RpcServer<SearchInWorkspaceClient>
- SearchInWorkspaceServer

Implemented by

RipgrepSearchInWorkspaceServer

Index

Methods

cancel dispose search

Methods

cancel

cancel(searchId): Promise<void>
Cancel an ongoing search.
Parameters
- searchId: number
Returns Promise<void>
- Defined in packages/search-in-workspace/src/common/search-in-workspace-interface.ts:150

dispose

dispose(): void
Returns void
Overrides RpcServer.dispose
- Defined in packages/search-in-workspace/src/common/search-in-workspace-interface.ts:152

search

search(what, rootUris, opts?): Promise<number>
Start a search for WHAT in directories ROOTURIS. Return a unique search id.
Parameters
- what: string
- rootUris: string[]
- Optional opts: SearchInWorkspaceOptions
Returns Promise<number>
- Defined in packages/search-in-workspace/src/common/search-in-workspace-interface.ts:145