Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DebugAdapterDescriptorFactory

Hierarchy

  • DebugAdapterDescriptorFactory

Index

Methods(1)

createDebugAdapterDescriptor

  • '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 DebugAdapterDescriptor. Currently two types of debug adapters are supported:

    • a debug adapter executable is specified as a command path and arguments (see DebugAdapterExecutable),
    • a debug adapter server reachable via a communication port (see 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 debug session for which the debug adapter will be used.

    • executable: undefined | DebugAdapterExecutable

      The debug adapter's executable information as specified in the package.json (or undefined if no such information exists).

    Returns ProviderResult<DebugAdapterDescriptor>

    a debug adapter descriptor or undefined.

Generated by TypeDoc. Maintained by 洛竹