Search
Preparing search index...
The search index is not available
Theia TypeDoc
Options
All
Public
Public/Protected
All
Inherited
Menu
Theia TypeDoc
search-in-workspace
SearchInWorkspaceService
Class SearchInWorkspaceService
Service to search text in the workspace files.
Hierarchy
SearchInWorkspaceService
Implements
SearchInWorkspaceClient
Index
Constructors
constructor
Properties
client
last
Known
Search
Id
logger
pending
OnDones
pending
Searches
search
Server
workspace
Service
Methods
cancel
do
Search
init
is
Enabled
on
Done
on
Result
search
search
With
Callback
Constructors
constructor
new
Search
InWorkspace
Service
(
)
:
SearchInWorkspaceService
Returns
SearchInWorkspaceService
Properties
Protected
Readonly
client
client
:
SearchInWorkspaceClientImpl
Private
last
Known
Search
Id
last
Known
Search
Id
:
number
= -1
Protected
Readonly
logger
logger
:
ILogger
Private
pending
OnDones
pending
OnDones
:
Map
<
number
,
undefined
|
string
>
= ...
Private
pending
Searches
pending
Searches
:
Map
<
number
,
SearchInWorkspaceClient
>
= ...
Protected
Readonly
search
Server
search
Server
:
SearchInWorkspaceServer
Protected
Readonly
workspace
Service
workspace
Service
:
WorkspaceService
Methods
cancel
cancel
(
searchId
:
number
)
:
void
Parameters
searchId:
number
Returns
void
Protected
do
Search
do
Search
(
what
:
string
, rootsUris
:
string
[]
, callbacks
:
SearchInWorkspaceClient
, opts
?:
SearchInWorkspaceOptions
)
:
Promise
<
number
>
Parameters
what:
string
rootsUris:
string
[]
callbacks:
SearchInWorkspaceClient
Optional
opts:
SearchInWorkspaceOptions
Returns
Promise
<
number
>
Protected
init
init
(
)
:
void
Returns
void
is
Enabled
is
Enabled
(
)
:
boolean
Returns
boolean
on
Done
on
Done
(
searchId
:
number
, error
?:
string
)
:
void
Parameters
searchId:
number
Optional
error:
string
Returns
void
on
Result
on
Result
(
searchId
:
number
, result
:
SearchInWorkspaceResult
)
:
void
Parameters
searchId:
number
result:
SearchInWorkspaceResult
Returns
void
search
search
(
what
:
string
, callbacks
:
SearchInWorkspaceClient
, opts
?:
SearchInWorkspaceOptions
)
:
Promise
<
number
>
Parameters
what:
string
callbacks:
SearchInWorkspaceClient
Optional
opts:
SearchInWorkspaceOptions
Returns
Promise
<
number
>
search
With
Callback
search
With
Callback
(
what
:
string
, rootsUris
:
string
[]
, callbacks
:
SearchInWorkspaceClient
, opts
?:
SearchInWorkspaceOptions
)
:
Promise
<
number
>
Parameters
what:
string
rootsUris:
string
[]
callbacks:
SearchInWorkspaceClient
Optional
opts:
SearchInWorkspaceOptions
Returns
Promise
<
number
>
Exports
search-
in-
workspace
Search
InWorkspace
Commands
Search
InWorkspace
File
Node
Search
InWorkspace
Result
Search
InWorkspace
Result
Line
Node
Search
InWorkspace
Root
Search
InWorkspace
Root
Folder
Node
Search
InWorkspace
Service
constructor
client
last
Known
Search
Id
logger
pending
OnDones
pending
Searches
search
Server
workspace
Service
cancel
do
Search
init
is
Enabled
on
Done
on
Result
search
search
With
Callback
Service to search text in the workspace files.