Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
DebugMain
Interface DebugMain
interface
DebugMain
{
$addBreakpoints
(
breakpoints
:
Breakpoint
[]
)
:
Promise
<
void
>
;
$appendLineToDebugConsole
(
value
:
string
)
:
Promise
<
void
>
;
$appendToDebugConsole
(
value
:
string
)
:
Promise
<
void
>
;
$customRequest
(
sessionId
:
string
,
command
:
string
,
args
?:
any
,
)
:
Promise
<
Response
>
;
$getDebugProtocolBreakpoint
(
sessionId
:
string
,
breakpointId
:
string
,
)
:
Promise
<
undefined
|
DebugProtocolBreakpoint
>
;
$registerDebugConfigurationProvider
(
description
:
DebugConfigurationProviderDescriptor
,
)
:
void
;
$registerDebuggerContribution
(
description
:
DebuggerDescription
,
)
:
Promise
<
void
>
;
$removeBreakpoints
(
breakpoints
:
string
[]
)
:
Promise
<
void
>
;
$startDebugging
(
folder
:
undefined
|
WorkspaceFolder
,
nameOrConfiguration
:
string
|
DebugConfiguration
,
options
:
DebugSessionOptions
,
)
:
Promise
<
boolean
>
;
$stopDebugging
(
sessionId
?:
string
)
:
Promise
<
void
>
;
$unregisterDebugConfigurationProvider
(
handle
:
number
)
:
Promise
<
void
>
;
$unregisterDebuggerConfiguration
(
debugType
:
string
)
:
Promise
<
void
>
;
}
Implemented by
DebugMainImpl
Index
Methods
$add
Breakpoints
$append
Line
To
Debug
Console
$append
To
Debug
Console
$custom
Request
$get
Debug
Protocol
Breakpoint
$register
Debug
Configuration
Provider
$register
Debugger
Contribution
$remove
Breakpoints
$start
Debugging
$stop
Debugging
$unregister
Debug
Configuration
Provider
$unregister
Debugger
Configuration
Methods
$add
Breakpoints
$addBreakpoints
(
breakpoints
:
Breakpoint
[]
)
:
Promise
<
void
>
Parameters
breakpoints
:
Breakpoint
[]
Returns
Promise
<
void
>
$append
Line
To
Debug
Console
$appendLineToDebugConsole
(
value
:
string
)
:
Promise
<
void
>
Parameters
value
:
string
Returns
Promise
<
void
>
$append
To
Debug
Console
$appendToDebugConsole
(
value
:
string
)
:
Promise
<
void
>
Parameters
value
:
string
Returns
Promise
<
void
>
$custom
Request
$customRequest
(
sessionId
:
string
,
command
:
string
,
args
?:
any
,
)
:
Promise
<
Response
>
Parameters
sessionId
:
string
command
:
string
Optional
args
:
any
Returns
Promise
<
Response
>
$get
Debug
Protocol
Breakpoint
$getDebugProtocolBreakpoint
(
sessionId
:
string
,
breakpointId
:
string
,
)
:
Promise
<
undefined
|
DebugProtocolBreakpoint
>
Parameters
sessionId
:
string
breakpointId
:
string
Returns
Promise
<
undefined
|
DebugProtocolBreakpoint
>
$register
Debug
Configuration
Provider
$registerDebugConfigurationProvider
(
description
:
DebugConfigurationProviderDescriptor
,
)
:
void
Parameters
description
:
DebugConfigurationProviderDescriptor
Returns
void
$register
Debugger
Contribution
$registerDebuggerContribution
(
description
:
DebuggerDescription
)
:
Promise
<
void
>
Parameters
description
:
DebuggerDescription
Returns
Promise
<
void
>
$remove
Breakpoints
$removeBreakpoints
(
breakpoints
:
string
[]
)
:
Promise
<
void
>
Parameters
breakpoints
:
string
[]
Returns
Promise
<
void
>
$start
Debugging
$startDebugging
(
folder
:
undefined
|
WorkspaceFolder
,
nameOrConfiguration
:
string
|
DebugConfiguration
,
options
:
DebugSessionOptions
,
)
:
Promise
<
boolean
>
Parameters
folder
:
undefined
|
WorkspaceFolder
nameOrConfiguration
:
string
|
DebugConfiguration
options
:
DebugSessionOptions
Returns
Promise
<
boolean
>
$stop
Debugging
$stopDebugging
(
sessionId
?:
string
)
:
Promise
<
void
>
Parameters
Optional
sessionId
:
string
Returns
Promise
<
void
>
$unregister
Debug
Configuration
Provider
$unregisterDebugConfigurationProvider
(
handle
:
number
)
:
Promise
<
void
>
Parameters
handle
:
number
Returns
Promise
<
void
>
$unregister
Debugger
Configuration
$unregisterDebuggerConfiguration
(
debugType
:
string
)
:
Promise
<
void
>
Parameters
debugType
:
string
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$add
Breakpoints
$append
Line
To
Debug
Console
$append
To
Debug
Console
$custom
Request
$get
Debug
Protocol
Breakpoint
$register
Debug
Configuration
Provider
$register
Debugger
Contribution
$remove
Breakpoints
$start
Debugging
$stop
Debugging
$unregister
Debug
Configuration
Provider
$unregister
Debugger
Configuration
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...