dots.vscode.debug-configuration-provider

Liking cljdoc? Tell your friends :D

ClojureScript only.

provide-debug-configurations
resolve-debug-configuration
resolve-debug-configuration-with-substituted-variables

A debug configuration provider allows to add debug configurations to the debug service and to resolve launch configurations before they are used to start a debug session. A debug configuration provider is registered via {@link debug.registerDebugConfigurationProvider }.

A debug configuration provider allows to add debug configurations to the debug service
and to resolve launch configurations before they are used to start a debug session.
A debug configuration provider is registered via {@link debug.registerDebugConfigurationProvider }.

raw docstring

provide-debug-configurations^cljs

(provide-debug-configurations debug-configuration-provider)

(provide-debug-configurations debug-configuration-provider folder)

(provide-debug-configurations debug-configuration-provider folder token)

Provides {@link DebugConfiguration debug configuration} to the debug service. If more than one debug configuration provider is registered for the same type, debug configurations are concatenated in arbitrary order.

Parameters:

folder: WorkspaceFolder | undefined - The workspace folder for which the configurations are used or undefined for a folderless setup.
token: CancellationToken | undefined - A cancellation token.

Returns: ProviderResult<DebugConfiguration[]> - An array of {@link DebugConfigurationdebug configurations}.

Provides {@link DebugConfiguration debug configuration} to the debug service. If more than one debug configuration provider is
registered for the same type, debug configurations are concatenated in arbitrary order.

**Parameters:**
- `folder`: `WorkspaceFolder | undefined` - The workspace folder for which the configurations are used or `undefined` for a folderless setup.
- `token`: `CancellationToken | undefined` - A cancellation token.

**Returns:** `ProviderResult<DebugConfiguration[]>` - An array of {@link DebugConfigurationdebug configurations}.

source raw docstring

resolve-debug-configuration^cljs

(resolve-debug-configuration debug-configuration-provider)

(resolve-debug-configuration debug-configuration-provider folder)

(resolve-debug-configuration debug-configuration-provider
                             folder
                             debug-configuration)

(resolve-debug-configuration debug-configuration-provider
                             folder
                             debug-configuration
                             token)

Resolves a {@link DebugConfiguration debug configuration} by filling in missing values or by adding/changing/removing attributes. If more than one debug configuration provider is registered for the same type, the resolveDebugConfiguration calls are chained in arbitrary order and the initial debug configuration is piped through the chain. Returning the value 'undefined' prevents the debug session from starting. Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.

Parameters:

folder: WorkspaceFolder | undefined - The workspace folder from which the configuration originates from or undefined for a folderless setup.
debug-configuration: DebugConfiguration - The {@link DebugConfiguration debug configuration} to resolve.
token: CancellationToken | undefined - A cancellation token.

Returns: ProviderResult<DebugConfiguration> - The resolved debug configuration or undefined or null.

Resolves a {@link DebugConfiguration debug configuration} by filling in missing values or by adding/changing/removing attributes.
If more than one debug configuration provider is registered for the same type, the resolveDebugConfiguration calls are chained
in arbitrary order and the initial debug configuration is piped through the chain.
Returning the value 'undefined' prevents the debug session from starting.
Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.

**Parameters:**
- `folder`: `WorkspaceFolder | undefined` - The workspace folder from which the configuration originates from or `undefined` for a folderless setup.
- `debug-configuration`: `DebugConfiguration` - The {@link DebugConfiguration debug configuration} to resolve.
- `token`: `CancellationToken | undefined` - A cancellation token.

**Returns:** `ProviderResult<DebugConfiguration>` - The resolved debug configuration or undefined or null.

source raw docstring

resolve-debug-configuration-with-substituted-variables^cljs

(resolve-debug-configuration-with-substituted-variables
  debug-configuration-provider)

(resolve-debug-configuration-with-substituted-variables
  debug-configuration-provider
  folder)

(resolve-debug-configuration-with-substituted-variables
  debug-configuration-provider
  folder
  debug-configuration)

(resolve-debug-configuration-with-substituted-variables
  debug-configuration-provider
  folder
  debug-configuration
  token)

This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted. It can be used to resolve or verify a {@link DebugConfiguration debug configuration} by filling in missing values or by adding/changing/removing attributes. If more than one debug configuration provider is registered for the same type, the 'resolveDebugConfigurationWithSubstitutedVariables' calls are chained in arbitrary order and the initial debug configuration is piped through the chain. Returning the value 'undefined' prevents the debug session from starting. Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.

Parameters:

folder: WorkspaceFolder | undefined - The workspace folder from which the configuration originates from or undefined for a folderless setup.
debug-configuration: DebugConfiguration - The {@link DebugConfiguration debug configuration} to resolve.
token: CancellationToken | undefined - A cancellation token.

Returns: ProviderResult<DebugConfiguration> - The resolved debug configuration or undefined or null.

This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted.
It can be used to resolve or verify a {@link DebugConfiguration debug configuration} by filling in missing values or by adding/changing/removing attributes.
If more than one debug configuration provider is registered for the same type, the 'resolveDebugConfigurationWithSubstitutedVariables' calls are chained
in arbitrary order and the initial debug configuration is piped through the chain.
Returning the value 'undefined' prevents the debug session from starting.
Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.

**Parameters:**
- `folder`: `WorkspaceFolder | undefined` - The workspace folder from which the configuration originates from or `undefined` for a folderless setup.
- `debug-configuration`: `DebugConfiguration` - The {@link DebugConfiguration debug configuration} to resolve.
- `token`: `CancellationToken | undefined` - A cancellation token.

**Returns:** `ProviderResult<DebugConfiguration>` - The resolved debug configuration or undefined or null.

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close