A debug adaper factory that creates {@link DebugAdapterDescriptor debug adapter descriptors}.
A debug adaper factory that creates {@link DebugAdapterDescriptor debug adapter descriptors}.
(create-debug-adapter-descriptor debug-adapter-descriptor-factory session)(create-debug-adapter-descriptor debug-adapter-descriptor-factory
session
executable)'createDebugAdapterDescriptor' is called at the start of a debug session to provide details about the debug adapter to use. These details must be returned as objects of type {@link DebugAdapterDescriptor }. Currently two types of debug adapters are supported:
Parameters:
session: DebugSession - The {@link DebugSession debug session} for which the debug adapter will be used.executable: DebugAdapterExecutable | undefined - The debug adapter's executable information as specified in the package.json (or undefined if no such information exists).Returns: ProviderResult<DebugAdapterDescriptor> - a {@link DebugAdapterDescriptordebug adapter descriptor} or undefined.
'createDebugAdapterDescriptor' is called at the start of a debug session to provide details about the debug adapter to use.
These details must be returned as objects of type {@link DebugAdapterDescriptor }.
Currently two types of debug adapters are supported:
- a debug adapter executable is specified as a command path and arguments (see {@link DebugAdapterExecutable }),
- a debug adapter server reachable via a communication port (see {@link DebugAdapterServer }).
If the method is not implemented the default behavior is this:
createDebugAdapter(session: DebugSession, executable: DebugAdapterExecutable) {
if (typeof session.configuration.debugServer === 'number') {
return new DebugAdapterServer(session.configuration.debugServer);
}
return executable;
}
**Parameters:**
- `session`: `DebugSession` - The {@link DebugSession debug session} for which the debug adapter will be used.
- `executable`: `DebugAdapterExecutable | undefined` - The debug adapter's executable information as specified in the package.json (or undefined if no such information exists).
**Returns:** `ProviderResult<DebugAdapterDescriptor>` - a {@link DebugAdapterDescriptordebug adapter descriptor} or undefined.cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |