Skip to content

_state_.state.md

Latest commit

 

History

History
320 lines (178 loc) · 5.3 KB

_state_.state.md

File metadata and controls

320 lines (178 loc) · 5.3 KB

@effectful/debugger › "state" › State

Interface: State

Hierarchy

  • State

Index

Properties

Properties

activeTop

• activeTop: Frame | null

Defined in debugger/src/state.ts:285

top of currently debugging thread, the value is saved here while some blackbox thread may run

brk

• brk: Brk | null

Defined in debugger/src/state.ts:245

current breakpoint id

brkOnAnyException

• brkOnAnyException: boolean

Defined in debugger/src/state.ts:278

stop on any exceptions

brkOnUncaughtException

• brkOnUncaughtException: boolean

Defined in debugger/src/state.ts:280

stop on uncaught exceptions

call

• call: any

Defined in debugger/src/state.ts:272

reference of a function which is expected to be called

debug

• debug: boolean

Defined in debugger/src/state.ts:234

stopping on break points if true, otherwise ignoring them

error

• error: boolean

Defined in debugger/src/state.ts:260

in error state

exception

• exception: any

Defined in debugger/src/state.ts:262

currently propagating exception

moduleId

• moduleId: string | null

Defined in debugger/src/state.ts:274

module id which is expected to be required

modules

• modules: object

Defined in debugger/src/state.ts:247

loaded modules (by full path)

Type declaration:

modulesById

• modulesById: object

Defined in debugger/src/state.ts:249

loaded modules (by CommonJs id)

Type declaration:

needsBreak

• needsBreak: function

Defined in debugger/src/state.ts:270

queries if the engine should stop on this brk

Type declaration:

▸ (brk: Brk, frame: Frame, param?: any): boolean

Parameters:

Name Type
brk Brk
frame Frame
param? any

Optional onLoad

• onLoad? : undefined | function

Defined in debugger/src/state.ts:266

a callback called when some module's sources are changed

onNewSource

• onNewSource: function

Defined in debugger/src/state.ts:287

some new generated source can be debugged

Type declaration:

▸ (id: number, code: string): void

Parameters:

Name Type
id number
code string

onStop

• onStop: function

Defined in debugger/src/state.ts:289

stopping on a breakpoint

Type declaration:

▸ (): void

onThread

• onThread: function

Defined in debugger/src/state.ts:258

this is called if something a new thread is added into queue or some thread was finished (so the caller can proceed with

Type declaration:

▸ (): void

queue

• queue: Job[]

Defined in debugger/src/state.ts:253

next functions to run

running

• running: boolean

Defined in debugger/src/state.ts:243

the engine now runs some code and expects a breakpoint otherwise it is some new thread which isn't tracked by the debugger and on next breakpoint it is suspended in queue, to run after with running: true (if the breakpoints aren't ignored by debug:false)

suspended

• suspended: Set‹Frame›

Defined in debugger/src/state.ts:276

currently suspended but not exited frames (e.g. on await expressions)

syncStack

• syncStack: Job[]

Defined in debugger/src/state.ts:251

saved context for synchronous functions

terminated

• terminated: boolean

Defined in debugger/src/state.ts:236

everything is done

threadId

• threadId: number

Defined in debugger/src/state.ts:292

unique number of this execution context

top

• top: Frame | null

Defined in debugger/src/state.ts:268

current execution stack

value

• value: any

Defined in debugger/src/state.ts:264

a current value to be passed into the top of stack (or an exception if error:true)