dots.vscode.debug

Liking cljdoc? Tell your friends :D

ClojureScript only.

active-debug-console
active-debug-session
add-breakpoints
as-debug-source-uri
breakpoints
on-did-change-active-debug-session
on-did-change-breakpoints
on-did-receive-debug-session-custom-event
on-did-start-debug-session
on-did-terminate-debug-session
register-debug-adapter-descriptor-factory
register-debug-adapter-tracker-factory
register-debug-configuration-provider
remove-breakpoints
start-debugging
stop-debugging

Namespace for debug functionality.

Namespace for debug functionality.

raw docstring

active-debug-console^cljs

(active-debug-console)

The currently active {@link DebugConsole debug console}. If no debug session is active, output sent to the debug console is not shown.

The currently active {@link DebugConsole debug console}.
If no debug session is active, output sent to the debug console is not shown.

source raw docstring

active-debug-session^cljs

(active-debug-session)

The currently active {@link DebugSession debug session} or undefined. The active debug session is the one represented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window. If no debug session is active, the value is undefined.

The currently active {@link DebugSession debug session} or `undefined`. The active debug session is the one
represented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window.
If no debug session is active, the value is `undefined`.

source raw docstring

add-breakpoints^cljs

(add-breakpoints breakpoints)

Add breakpoints.

Parameters:

breakpoints: readonly Breakpoint[] - The breakpoints to add.

Returns: void

Add breakpoints.

**Parameters:**
- `breakpoints`: `readonly Breakpoint[]` - The breakpoints to add.

**Returns:** `void`

source raw docstring

as-debug-source-uri^cljs

(as-debug-source-uri source)

(as-debug-source-uri source session)

Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents. If the source descriptor is based on a path, a file Uri is returned. If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding ContentProvider and a running debug session

If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.

Parameters:

source: DebugProtocolSource - An object conforming to the Source type defined in the Debug Adapter Protocol.
session: DebugSession | undefined - An optional debug session that will be used when the source descriptor uses a reference number to load the contents from an active debug session.

Returns: Uri - A uri that can be used to load the contents of the source.

Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents.
If the source descriptor is based on a path, a file Uri is returned.
If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding ContentProvider and a running debug session

If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.

**Parameters:**
- `source`: `DebugProtocolSource` - An object conforming to the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
- `session`: `DebugSession | undefined` - An optional debug session that will be used when the source descriptor uses a reference number to load the contents from an active debug session.

**Returns:** `Uri` - A uri that can be used to load the contents of the source.

source raw docstring

breakpoints^cljs

(breakpoints)

List of breakpoints.

List of breakpoints.

source raw docstring

on-did-change-active-debug-session^cljs

(on-did-change-active-debug-session)

(on-did-change-active-debug-session listener)

(on-did-change-active-debug-session listener this-args)

(on-did-change-active-debug-session listener this-args disposables)

An {@link Event } which fires when the {@link debug.activeDebugSession active debug session} has changed. Note that the event also fires when the active debug session changes to undefined.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

An {@link Event } which fires when the {@link debug.activeDebugSession active debug session}
has changed. *Note* that the event also fires when the active debug session changes
to `undefined`.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-change-breakpoints^cljs

(on-did-change-breakpoints)

(on-did-change-breakpoints listener)

(on-did-change-breakpoints listener this-args)

(on-did-change-breakpoints listener this-args disposables)

An {@link Event } that is emitted when the set of breakpoints is added, removed, or changed.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

An {@link Event } that is emitted when the set of breakpoints is added, removed, or changed.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-receive-debug-session-custom-event^cljs

(on-did-receive-debug-session-custom-event)

(on-did-receive-debug-session-custom-event listener)

(on-did-receive-debug-session-custom-event listener this-args)

(on-did-receive-debug-session-custom-event listener this-args disposables)

An {@link Event } which fires when a custom DAP event is received from the {@link DebugSession debug session}.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

An {@link Event } which fires when a custom DAP event is received from the {@link DebugSession debug session}.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-start-debug-session^cljs

(on-did-start-debug-session)

(on-did-start-debug-session listener)

(on-did-start-debug-session listener this-args)

(on-did-start-debug-session listener this-args disposables)

An {@link Event } which fires when a new {@link DebugSession debug session} has been started.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

An {@link Event } which fires when a new {@link DebugSession debug session} has been started.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-terminate-debug-session^cljs

(on-did-terminate-debug-session)

(on-did-terminate-debug-session listener)

(on-did-terminate-debug-session listener this-args)

(on-did-terminate-debug-session listener this-args disposables)

An {@link Event } which fires when a {@link DebugSession debug session} has terminated.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

An {@link Event } which fires when a {@link DebugSession debug session} has terminated.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

register-debug-adapter-descriptor-factory^cljs

(register-debug-adapter-descriptor-factory debug-type factory)

Register a {@link DebugAdapterDescriptorFactory debug adapter descriptor factory} for a specific debug type. An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown. Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.

Parameters:

debug-type: string - The debug type for which the factory is registered.
factory: DebugAdapterDescriptorFactory - The {@link DebugAdapterDescriptorFactory debug adapter descriptor factory} to register.

Returns: Disposable - A {@link Disposable} that unregisters this factory when being disposed.

Register a {@link DebugAdapterDescriptorFactory debug adapter descriptor factory} for a specific debug type.
An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown.
Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.

**Parameters:**
- `debug-type`: `string` - The debug type for which the factory is registered.
- `factory`: `DebugAdapterDescriptorFactory` - The {@link DebugAdapterDescriptorFactory debug adapter descriptor factory} to register.

**Returns:** `Disposable` - A {@link Disposable} that unregisters this factory when being disposed.

source raw docstring

register-debug-adapter-tracker-factory^cljs

(register-debug-adapter-tracker-factory debug-type factory)

Parameters:

debug-type: string - The debug type for which the factory is registered or '*' for matching all debug types.
factory: DebugAdapterTrackerFactory - The {@link DebugAdapterTrackerFactory debug adapter tracker factory} to register.

Returns: Disposable - A {@link Disposable} that unregisters this factory when being disposed.

Register a debug adapter tracker factory for the given debug type.

**Parameters:**
- `debug-type`: `string` - The debug type for which the factory is registered or '*' for matching all debug types.
- `factory`: `DebugAdapterTrackerFactory` - The {@link DebugAdapterTrackerFactory debug adapter tracker factory} to register.

**Returns:** `Disposable` - A {@link Disposable} that unregisters this factory when being disposed.

source raw docstring

register-debug-configuration-provider^cljs

(register-debug-configuration-provider debug-type provider)

(register-debug-configuration-provider debug-type provider trigger-kind)

Register a {@link DebugConfigurationProvider debug configuration provider} for a specific debug type. The optional {@link DebugConfigurationProviderTriggerKind triggerKind} can be used to specify when the provideDebugConfigurations method of the provider is triggered. Currently two trigger kinds are possible: with the value Initial (or if no trigger kind argument is given) the provideDebugConfigurations method is used to provide the initial debug configurations to be copied into a newly created launch.json. With the trigger kind Dynamic the provideDebugConfigurations method is used to dynamically determine debug configurations to be presented to the user (in addition to the static configurations from the launch.json). Please note that the triggerKind argument only applies to the provideDebugConfigurations method: so the resolveDebugConfiguration methods are not affected at all. Registering a single provider with resolve methods for different trigger kinds, results in the same resolve methods called multiple times. More than one provider can be registered for the same type.

Parameters:

debug-type: string - The debug type for which the provider is registered.
provider: DebugConfigurationProvider - The {@link DebugConfigurationProvider debug configuration provider} to register.
trigger-kind: DebugConfigurationProviderTriggerKind | undefined - The {@link DebugConfigurationProviderTriggerKind trigger} for which the 'provideDebugConfiguration' method of the provider is registered. If triggerKind is missing, the value DebugConfigurationProviderTriggerKind.Initial is assumed.

Returns: Disposable - A {@link Disposable} that unregisters this provider when being disposed.

Register a {@link DebugConfigurationProvider debug configuration provider} for a specific debug type.
The optional {@link DebugConfigurationProviderTriggerKind triggerKind} can be used to specify when the `provideDebugConfigurations` method of the provider is triggered.
Currently two trigger kinds are possible: with the value `Initial` (or if no trigger kind argument is given) the `provideDebugConfigurations` method is used to provide the initial debug configurations to be copied into a newly created launch.json.
With the trigger kind `Dynamic` the `provideDebugConfigurations` method is used to dynamically determine debug configurations to be presented to the user (in addition to the static configurations from the launch.json).
Please note that the `triggerKind` argument only applies to the `provideDebugConfigurations` method: so the `resolveDebugConfiguration` methods are not affected at all.
Registering a single provider with resolve methods for different trigger kinds, results in the same resolve methods called multiple times.
More than one provider can be registered for the same type.

**Parameters:**
- `debug-type`: `string` - The debug type for which the provider is registered.
- `provider`: `DebugConfigurationProvider` - The {@link DebugConfigurationProvider debug configuration provider} to register.
- `trigger-kind`: `DebugConfigurationProviderTriggerKind | undefined` - The {@link DebugConfigurationProviderTriggerKind trigger} for which the 'provideDebugConfiguration' method of the provider is registered. If `triggerKind` is missing, the value `DebugConfigurationProviderTriggerKind.Initial` is assumed.

**Returns:** `Disposable` - A {@link Disposable} that unregisters this provider when being disposed.

source raw docstring

remove-breakpoints^cljs

(remove-breakpoints breakpoints)

Remove breakpoints.

Parameters:

breakpoints: readonly Breakpoint[] - The breakpoints to remove.

Returns: void

Remove breakpoints.

**Parameters:**
- `breakpoints`: `readonly Breakpoint[]` - The breakpoints to remove.

**Returns:** `void`

source raw docstring

start-debugging^cljs

(start-debugging)

(start-debugging folder)

(start-debugging folder name-or-configuration)

(start-debugging folder name-or-configuration parent-session-or-options)

Start debugging by using either a named launch or named compound configuration, or by directly passing a {@link DebugConfiguration }. The named configurations are looked up in '.vscode/launch.json' found in the given folder. Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date. Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.

Parameters:

folder: WorkspaceFolder | undefined - The {@link WorkspaceFolder workspace folder} for looking up named configurations and resolving variables or undefined for a non-folder setup.
name-or-configuration: string | DebugConfiguration - Either the name of a debug or compound configuration or a {@link DebugConfiguration } object.
parent-session-or-options: DebugSession | DebugSessionOptions | undefined - Debug session options. When passed a parent {@link DebugSession debug session}, assumes options with just this parent session.

Returns: Thenable<boolean> - A thenable that resolves when debugging could be successfully started.

Start debugging by using either a named launch or named compound configuration,
or by directly passing a {@link DebugConfiguration }.
The named configurations are looked up in '.vscode/launch.json' found in the given folder.
Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date.
Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.

**Parameters:**
- `folder`: `WorkspaceFolder | undefined` - The {@link WorkspaceFolder workspace folder} for looking up named configurations and resolving variables or `undefined` for a non-folder setup.
- `name-or-configuration`: `string | DebugConfiguration` - Either the name of a debug or compound configuration or a {@link DebugConfiguration } object.
- `parent-session-or-options`: `DebugSession | DebugSessionOptions | undefined` - Debug session options. When passed a parent {@link DebugSession debug session}, assumes options with just this parent session.

**Returns:** `Thenable<boolean>` - A thenable that resolves when debugging could be successfully started.

source raw docstring

stop-debugging^cljs

(stop-debugging)

(stop-debugging session)

Stop the given debug session or stop all debug sessions if session is omitted.

Parameters:

session: DebugSession | undefined - The {@link DebugSession debug session} to stop; if omitted all sessions are stopped.

Returns: Thenable<void> - A thenable that resolves when the session(s) have been stopped.

Stop the given debug session or stop all debug sessions if session is omitted.

**Parameters:**
- `session`: `DebugSession | undefined` - The {@link DebugSession debug session} to stop; if omitted all sessions are stopped.

**Returns:** `Thenable<void>` - A thenable that resolves when the session(s) have been stopped.

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close