InspectorDriveContext
Defined in: Inspector.ts:637
The verbs Inspector.drive hands its callback.
Properties
Section titled “Properties”events
Section titled “events”
readonlyevents:object
Defined in: Inspector.ts:657
clearLog
Section titled “clearLog”clearLog: () =>
void
Returns
Section titled “Returns”void
getLog
Section titled “getLog”getLog: () =>
EventLogEntry[]
Returns
Section titled “Returns”isEnabled
Section titled “isEnabled”isEnabled: () =>
boolean
Returns
Section titled “Returns”boolean
setCapacity
Section titled “setCapacity”setCapacity: (
n) =>void
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setEnabled
Section titled “setEnabled”setEnabled: (
enabled) =>void
Turn event-log recording on/off at runtime. Off means zero per-event
allocation: the EventBus tap detaches and recordBusEvent is never
called. DebugConfig.eventLog controls the startup default; this is
the runtime switch for toggling mid-session.
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
waitFor
Section titled “waitFor”waitFor: (
pattern,options?) =>Promise<EventLogEntry>
Resolve the earliest retained match without consuming it, or wait for a
future match. Clear the log before an action to require a new event.
withinFrames expires after that many completed engine frames; events
on the deadline frame match first. Zero searches retained history only.
Disposing the Inspector or disabling the log rejects pending waits.
Parameters
Section titled “Parameters”pattern
Section titled “pattern”string | RegExp
options?
Section titled “options?”source?
Section titled “source?”"scene" | "entity" | "bus"
withinFrames?
Section titled “withinFrames?”number
Returns
Section titled “Returns”Promise<EventLogEntry>
framesUsed
Section titled “framesUsed”
readonlyframesUsed:number
Defined in: Inspector.ts:639
Frames this drive has spent so far, counting frames issued any way.
readonlyinput:InspectorDriveInput
Defined in: Inspector.ts:650
pointer
Section titled “pointer”
readonlypointer:object
Defined in: Inspector.ts:656
Clicks that reach @yagejs/ui elements, which input never does.
Dispatching spends no frame, so these are the same verbs
Inspector.pointer carries, handed through unchanged.
click: (
target,opts?) =>InspectorPointerHit
Presses and releases at one point, which is what a UIButton requires
to run its onClick.
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”down: (
target,opts?) =>InspectorPointerHit
Presses a mouse button, left unless opts says otherwise.
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”hitTest
Section titled “hitTest”hitTest: (
target) =>InspectorPointerHit
Resolves target and reports what is under it, dispatching nothing.
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”move: (
target) =>InspectorPointerHit
Moves the pointer, which drives hover state. Takes no button: a move presses and releases nothing, and carries whichever buttons an earlier down left held.
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”up: (
target,opts?) =>InspectorPointerHit
Releases a mouse button, left unless opts says otherwise.
Parameters
Section titled “Parameters”target
Section titled “target”Returns
Section titled “Returns”Methods
Section titled “Methods”capture()
Section titled “capture()”capture(
label?):Promise<string>
Defined in: Inspector.ts:659
Screenshots into the result, resolving with a PNG data URL.
Parameters
Section titled “Parameters”label?
Section titled “label?”string
Returns
Section titled “Returns”Promise<string>
step()
Section titled “step()”step(
frames?,opts?):Promise<void>
Defined in: Inspector.ts:641
Advances frames frames, one at a time.
Parameters
Section titled “Parameters”frames?
Section titled “frames?”number
Returns
Section titled “Returns”Promise<void>
until()
Section titled “until()”until(
predicate,opts?):Promise<number>
Defined in: Inspector.ts:646
Steps until predicate holds, resolving with the frames it took. Checks
before the first frame, and throws once maxFrames is spent.
Parameters
Section titled “Parameters”predicate
Section titled “predicate”() => boolean
Returns
Section titled “Returns”Promise<number>
Coding agents: fetch https://yage.dev/llms.txt first and prefer the Markdown references it links over these HTML pages. This page's Markdown counterpart is /llms/packages/core.md.