ScopeSession
ScopeSession<
TData> =AsyncDisposable&object
Defined in: packages/app-report/src/util/open-scope.ts:41
Type Declaration
Section titled “Type Declaration”
readonlyid:ReportScopeId
started
Section titled “started”
readonlystarted:Promise<void>
Resolves once scope-start has been accepted by the writer, for a caller
that needs acknowledgement. Rejects with the write failure.
attach()
Section titled “attach()”attach(
body,mediaType,name?):void
Parameters
Section titled “Parameters”string | Uint8Array<ArrayBufferLike>
mediaType
Section titled “mediaType”string
string
Returns
Section titled “Returns”void
attributes()
Section titled “attributes()”attributes(
attributes):void
Parameters
Section titled “Parameters”attributes
Section titled “attributes”Returns
Section titled “Returns”void
child()
Section titled “child()”child(
title,options?):ScopeSession<TData>
A nested scope sharing this session’s writer and ordering chain.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”ScopeSessionOptions<TData>
Returns
Section titled “Returns”ScopeSession<TData>
data()
Section titled “data()”data(
data):void
Parameters
Section titled “Parameters”TData
Returns
Section titled “Returns”void
diagnostic()
Section titled “diagnostic()”diagnostic(
diagnostic):void
Parameters
Section titled “Parameters”diagnostic
Section titled “diagnostic”attributes?
Section titled “attributes?”Record<string, unknown> = ...
string = ...
Stable, domain-defined identifier, e.g. "high-variance".
message
Section titled “message”string = ...
severity
Section titled “severity”"info" | "warning" | "error" = reportDiagnosticSeveritySchema
Returns
Section titled “Returns”void
fail()
Section titled “fail()”fail(
error?):void
Parameters
Section titled “Parameters”error?
Section titled “error?”unknown
Returns
Section titled “Returns”void
heartbeat()
Section titled “heartbeat()”heartbeat(
elapsedMs?,message?):void
Parameters
Section titled “Parameters”elapsedMs?
Section titled “elapsedMs?”number
message?
Section titled “message?”string
Returns
Section titled “Returns”void
output()
Section titled “output()”output(
stream,chunk):void
Parameters
Section titled “Parameters”stream
Section titled “stream”"stdout" | "stderr"
string
Returns
Section titled “Returns”void
progress()
Section titled “progress()”progress(
completed,total?,message?):void
Parameters
Section titled “Parameters”completed
Section titled “completed”number
total?
Section titled “total?”number
message?
Section titled “message?”string
Returns
Section titled “Returns”void
skip()
Section titled “skip()”skip():
void
Returns
Section titled “Returns”void
write()
Section titled “write()”write(
payload):void
The primitive every helper below is one call to. Stamps timestamp and
scopeId, appends to the ordering chain, and returns immediately.
Parameters
Section titled “Parameters”payload
Section titled “payload”ReportEventPayload<TData>
Returns
Section titled “Returns”void
Type Parameters
Section titled “Type Parameters”TData