Interface: SessionDiagnostic
@termwright/driver / SessionDiagnostic
Interface: SessionDiagnostic
Section titled “Interface: SessionDiagnostic”Defined in: driver/src/api.ts:1059
One entry of the session diagnostics log.
Properties
Section titled “Properties”actionId?
Section titled “actionId?”
readonlyoptionalactionId?:string
Defined in: driver/src/api.ts:1065
Correlates an action-observation wait with its action lifecycle.
readonlycode:DiagnosticCode
Defined in: driver/src/api.ts:1060
count?
Section titled “count?”
readonlyoptionalcount?:number
Defined in: driver/src/api.ts:1078
How many items the entry accounts for, when it stands for several — the number that would otherwise be readable only by parsing detail.
Present on aggregate entries: records an adapter dropped upstream, records
or lines the driver refused over budget. Absent when the entry is about one
identified thing (a single revision, a single refused duplicate), because
there is nothing to count there. Summing count over log-dropped
entries therefore answers “how many log entries never reached me”.
detail
Section titled “detail”
readonlydetail:string
Defined in: driver/src/api.ts:1061
readonlyoptionalmode?:"mouse"|"focus"
Defined in: driver/src/api.ts:1089
For mode-unverifiable: which mode could not be verified. A field rather
than a code per mode, so a consumer reacting to “the driver is working
blind” writes one branch instead of a list that grows with the platform.
observationState?
Section titled “observationState?”
readonlyoptionalobservationState?:"parser-in-flight"|"semantic-frame-open"|"pairing-pending"
Defined in: driver/src/api.ts:1067
The in-flight boundary an action is waiting to cross.
revision?
Section titled “revision?”
readonlyoptionalrevision?:number
Defined in: driver/src/api.ts:1063
The semantic revision the entry is about, when it is about one.
timeMs
Section titled “timeMs”
readonlytimeMs:number
Defined in: driver/src/api.ts:1090
wireCode?
Section titled “wireCode?”
readonlyoptionalwireCode?:"adapter-guarantee-violation"|"duplicate-semantic-key"|"bad-token"|"bad-version"|"malformed"|"limit-exceeded"|"capability-provider-violation"|"internal"
Defined in: driver/src/api.ts:1083
For protocol-violation: the wire error code sent to the adapter, so a
caller can tell which failure closed the channel without parsing prose.