Class SearchInWorkspaceService

Service to search text in the workspace files.

Implements

SearchInWorkspaceClient

Index

Constructors

Properties

client lastKnownSearchId logger pendingOnDones pendingSearches searchServer workspaceService

Methods

cancel doSearch init isEnabled onDone onResult search searchWithCallback

Constructors

constructor

new SearchInWorkspaceService(): SearchInWorkspaceService
Returns SearchInWorkspaceService

Properties

`Protected` `Readonly` client

client: SearchInWorkspaceClientImpl

`Private` lastKnownSearchId

lastKnownSearchId: number = -1

`Protected` `Readonly` logger

logger: ILogger

`Private` pendingOnDones

pendingOnDones: Map<number, undefined | string> = ...

`Private` pendingSearches

pendingSearches: Map<number, SearchInWorkspaceClient> = ...

`Protected` `Readonly` searchServer

searchServer: SearchInWorkspaceServer

`Protected` `Readonly` workspaceService

workspaceService: WorkspaceService

Methods

cancel

cancel(searchId): void
Parameters
- searchId: number
Returns void
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:148

`Protected` doSearch

doSearch(what, rootsUris, callbacks, opts?): Promise<number>
Parameters
- what: string
- rootsUris: string[]
- callbacks: SearchInWorkspaceClient
- Optional opts: SearchInWorkspaceOptions
Returns Promise<number>
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:120

`Protected` init

init(): void
Returns void
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:77

isEnabled

isEnabled(): boolean
Returns boolean
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:81

onDone

onDone(searchId, error?): void
Called when no more search matches will come.
Parameters
- searchId: number
- Optional error: string
Returns void
Implementation of SearchInWorkspaceClient.onDone
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:93

onResult

onResult(searchId, result): void
Called by the server for every search match.
Parameters
- searchId: number
- result: SearchInWorkspaceResult
Returns void
Implementation of SearchInWorkspaceClient.onResult
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:85

search

search(what, callbacks, opts?): Promise<number>
Parameters
- what: string
- callbacks: SearchInWorkspaceClient
- Optional opts: SearchInWorkspaceOptions
Returns Promise<number>
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:111

searchWithCallback

searchWithCallback(what, rootsUris, callbacks, opts?): Promise<number>
Parameters
- what: string
- rootsUris: string[]
- callbacks: SearchInWorkspaceClient
- Optional opts: SearchInWorkspaceOptions
Returns Promise<number>
- Defined in packages/search-in-workspace/src/browser/search-in-workspace-service.ts:143