Debug API
TypeScript
With the Debug API you can start debug sessions, view the output, call methods, remotely debug the process, etc.
Events
This API has 5 events that can be subscribed to.
To receive events, call the the 'client.debug.on' function on the API client. This will register a callback to fire when the Decthings server sends events to the client. In order for Decthings to send events, you must be subscribed to each debug session. This can be done using the subscribeToEvents method. Alternatively, when you start a debug session using launchDebugSession, you will by default atomatically be subscribed to events for that session.
/**
* Event emitted when a debug session exits.
*/
on(event: 'exit', handler: (params: {
debugSessionId: string,
reason: DebugSessionTerminatedReason
}) => void): this
/**
* Event emitted when output for a debug session is received on standard output (for example "console.log(msg)").
*/
on(event: 'stdout', handler: (params: {
debugSessionId: string,
data: Buffer
}) => void): this
/**
* Event emitted when output for a debug session is received on standard output (for example
* "console.error(msg)").
*/
on(event: 'stderr', handler: (params: {
debugSessionId: string,
data: Buffer
}) => void): this
/**
* Event emitted when a debug session has been initialized, which means it's ready to execute functions.
*/
on(event: 'initialized', handler: (params: {
debugSessionId: string
}) => void): this
/**
* Event emitted when output from the remote inspector is received.
*/
on(event: 'remoteInspectorData', handler: (params: {
debugSessionId: string,
data: Buffer
}) => void): thisWhere "DebugSessionTerminatedReason" is defined as:
export type DebugSessionTerminatedReason = {
code: 'terminated_on_request' | 'launcher_terminated' | 'inactive_timeout' | 'unknown'
} | {
code: 'code_terminated',
exitCode?: number,
signal?: string,
oom: boolean
} | {
code: 'exception',
exceptionDetails?: string
}Subscribe to events example
exit
let client = new DecthingsClient({ apiKey: "<myapikey>" })
async function main() {
// First, subscribe to events so that Decthings will actually send us any
await client.debug.subscribeToEvents({ debugSessionId: '<debugsessionid>' })
// Next, attach a listener which will be called when Decthings sends us events
client.debug.on('exit', ({ debugSessionId, reason }) => {
// This function will run when an event is received
console.log(debugSessionId)
console.log(reason)
})
}
main()