Interface SearchInWorkspaceServer

Hierarchy

JsonRpcServer<SearchInWorkspaceClient>
- SearchInWorkspaceServer

Index

Methods

Methods

cancel

cancel(searchId: number): Promise<void>

- Defined in packages/search-in-workspace/src/common/search-in-workspace-interface.ts:142
Cancel an ongoing search.

Parameters
- searchId: number
Returns Promise<void>

dispose

dispose(): void

Overrides JsonRpcServer.dispose
- Defined in packages/search-in-workspace/src/common/search-in-workspace-interface.ts:144
Returns void

Optional getClient

getClient(): undefined | SearchInWorkspaceClient

Inherited from JsonRpcServer.getClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:27
Returns undefined | SearchInWorkspaceClient

search

search(what: string, rootUris: string[], opts?: SearchInWorkspaceOptions): Promise<number>

- Defined in packages/search-in-workspace/src/common/search-in-workspace-interface.ts:137
Start a search for WHAT in directories ROOTURIS. Return a unique search id.

Parameters
- what: string
- rootUris: string[]
- Optional opts: SearchInWorkspaceOptions
Returns Promise<number>

setClient

setClient(client: undefined | SearchInWorkspaceClient): void

Inherited from JsonRpcServer.setClient
- Defined in packages/core/lib/common/messaging/proxy-factory.d.ts:26
If this server is a proxy to a remote server then a client is used as a local object to handle JSON-RPC messages from the remote server.

Parameters
- client: undefined | SearchInWorkspaceClient
Returns void