sandbox-failure
Classes
Section titled “Classes”SourceInvalid
Section titled “SourceInvalid”A location in the submitted program, never in the host’s source.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SourceInvalid(
args):SourceInvalid
Parameters
Section titled “Parameters”string
number
column
Section titled “column”number
excerpt
Section titled “excerpt”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError("SourceInvalid")< SandboxFailureReference & { readonly line: number; readonly column: number; readonly excerpt: string; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("SourceInvalid").ref
readonlyline:number
Inherited from
Section titled “Inherited from”Data.TaggedError("SourceInvalid").line
column
Section titled “column”
readonlycolumn:number
Inherited from
Section titled “Inherited from”Data.TaggedError("SourceInvalid").column
excerpt
Section titled “excerpt”
readonlyexcerpt:string
Inherited from
Section titled “Inherited from”Data.TaggedError("SourceInvalid").excerpt
GuestThrew
Section titled “GuestThrew”Text captured inside the guest’s own exception handler.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GuestThrew(
args):GuestThrew
Parameters
Section titled “Parameters”string
string
message
Section titled “message”string
missingVariable?
Section titled “missingVariable?”string
transportMessage?
Section titled “transportMessage?”string
Safe provider envelope carried in the guest exception’s cause, never model text.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError(“GuestThrew”)< SandboxFailureReference & { readonly name: string; readonly message: string; readonly missingVariable?: string | undefined; /** Safe provider envelope carried in the guest exception’s cause, never model text. */ readonly transportMessage?: string | undefined; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("GuestThrew").ref
missingVariable?
Section titled “missingVariable?”
readonlyoptionalmissingVariable?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("GuestThrew").missingVariable
transportMessage?
Section titled “transportMessage?”
readonlyoptionaltransportMessage?:string
Safe provider envelope carried in the guest exception’s cause, never model text.
Inherited from
Section titled “Inherited from”Data.TaggedError("GuestThrew").transportMessage
name:
string
Inherited from
Section titled “Inherited from”Data.TaggedError("GuestThrew").name
message
Section titled “message”message:
string
Inherited from
Section titled “Inherited from”Data.TaggedError("GuestThrew").message
DeadlineExceeded
Section titled “DeadlineExceeded”The invocation owner decided its execution budget was spent.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DeadlineExceeded(
args):DeadlineExceeded
Parameters
Section titled “Parameters”string
limitMs
Section titled “limitMs”number
elapsedMs
Section titled “elapsedMs”number
acknowledged?
Section titled “acknowledged?”boolean
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError(“DeadlineExceeded”)< SandboxFailureReference & { readonly limitMs: number; readonly elapsedMs: number; readonly acknowledged?: boolean | undefined; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("DeadlineExceeded").ref
limitMs
Section titled “limitMs”
readonlylimitMs:number
Inherited from
Section titled “Inherited from”Data.TaggedError("DeadlineExceeded").limitMs
elapsedMs
Section titled “elapsedMs”
readonlyelapsedMs:number
Inherited from
Section titled “Inherited from”Data.TaggedError("DeadlineExceeded").elapsedMs
acknowledged?
Section titled “acknowledged?”
readonlyoptionalacknowledged?:boolean
Inherited from
Section titled “Inherited from”Data.TaggedError("DeadlineExceeded").acknowledged
Cancelled
Section titled “Cancelled”The invocation owner accepted cancellation.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Cancelled(
args):Cancelled
Parameters
Section titled “Parameters”string
"caller" | "operator"
acknowledged?
Section titled “acknowledged?”boolean
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError(“Cancelled”)< SandboxFailureReference & { readonly by: “caller” | “operator”; readonly acknowledged?: boolean | undefined; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("Cancelled").ref
readonlyby:"caller"|"operator"
Inherited from
Section titled “Inherited from”Data.TaggedError("Cancelled").by
acknowledged?
Section titled “acknowledged?”
readonlyoptionalacknowledged?:boolean
Inherited from
Section titled “Inherited from”Data.TaggedError("Cancelled").acknowledged
DispatchLost
Section titled “DispatchLost”Dispatch started, but its transport did not deliver an answer.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DispatchLost(
args):DispatchLost
Parameters
Section titled “Parameters”string
elapsedMs
Section titled “elapsedMs”number
transport
Section titled “transport”string
errno?
Section titled “errno?”string
rawCause
Section titled “rawCause”unknown
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError(“DispatchLost”)< SandboxFailureReference & { readonly elapsedMs: number; readonly transport: string; readonly errno?: string | undefined; readonly rawCause: unknown; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("DispatchLost").ref
elapsedMs
Section titled “elapsedMs”
readonlyelapsedMs:number
Inherited from
Section titled “Inherited from”Data.TaggedError("DispatchLost").elapsedMs
transport
Section titled “transport”
readonlytransport:string
Inherited from
Section titled “Inherited from”Data.TaggedError("DispatchLost").transport
errno?
Section titled “errno?”
readonlyoptionalerrno?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("DispatchLost").errno
rawCause
Section titled “rawCause”
readonlyrawCause:unknown
Inherited from
Section titled “Inherited from”Data.TaggedError("DispatchLost").rawCause
SandboxCrashed
Section titled “SandboxCrashed”The sandbox process could not start or stopped before answering.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SandboxCrashed(
args):SandboxCrashed
Parameters
Section titled “Parameters”string
number
errno?
Section titled “errno?”string
rawCause
Section titled “rawCause”unknown
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError(“SandboxCrashed”)< SandboxFailureReference & { readonly exit?: number | undefined; readonly errno?: string | undefined; readonly rawCause: unknown; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("SandboxCrashed").ref
readonlyoptionalexit?:number
Inherited from
Section titled “Inherited from”Data.TaggedError("SandboxCrashed").exit
errno?
Section titled “errno?”
readonlyoptionalerrno?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("SandboxCrashed").errno
rawCause
Section titled “rawCause”
readonlyrawCause:unknown
Inherited from
Section titled “Inherited from”Data.TaggedError("SandboxCrashed").rawCause
BadResponse
Section titled “BadResponse”A received envelope could not be decoded. Its reason is operator only.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BadResponse(
args):BadResponse
Parameters
Section titled “Parameters”string
reason
Section titled “reason”string
rawCause
Section titled “rawCause”unknown
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError("BadResponse")< SandboxFailureReference & { readonly reason: string; readonly rawCause: unknown; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("BadResponse").ref
reason
Section titled “reason”
readonlyreason:string
Inherited from
Section titled “Inherited from”Data.TaggedError("BadResponse").reason
rawCause
Section titled “rawCause”
readonlyrawCause:unknown
Inherited from
Section titled “Inherited from”Data.TaggedError("BadResponse").rawCause
ResultTooLarge
Section titled “ResultTooLarge”A JSON result exceeded Mycelium’s output budget.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ResultTooLarge(
args):ResultTooLarge
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError("ResultTooLarge")< SandboxFailureReference & { readonly size: number; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("ResultTooLarge").ref
readonlysize:number
Inherited from
Section titled “Inherited from”Data.TaggedError("ResultTooLarge").size
ResultNotJson
Section titled “ResultNotJson”A result could not be represented as JSON.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ResultNotJson(
args):ResultNotJson
Parameters
Section titled “Parameters”string
string
rawCause?
Section titled “rawCause?”unknown
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError("ResultNotJson")< SandboxFailureReference & { readonly kind: string; readonly rawCause?: unknown; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("ResultNotJson").ref
readonlykind:string
Inherited from
Section titled “Inherited from”Data.TaggedError("ResultNotJson").kind
rawCause?
Section titled “rawCause?”
readonlyoptionalrawCause?:unknown
Inherited from
Section titled “Inherited from”Data.TaggedError("ResultNotJson").rawCause
CapabilityFailed
Section titled “CapabilityFailed”Failure at a named capability boundary, with an owner-admitted diagnostic.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<CapabilityFailureFields>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CapabilityFailed(
fields):CapabilityFailed
Retain the admitted diagnostic for ordinary Error consumers through the same safe projection.
Parameters
Section titled “Parameters”fields
Section titled “fields”Returns
Section titled “Returns”Overrides
Section titled “Overrides”Data.TaggedError( "CapabilityFailed", )<CapabilityFailureFields>.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError( "CapabilityFailed", ).ref
namespace
Section titled “namespace”
readonlynamespace:string
Inherited from
Section titled “Inherited from”Data.TaggedError( "CapabilityFailed", ).namespace
operation
Section titled “operation”
readonlyoperation:string
Inherited from
Section titled “Inherited from”Data.TaggedError( "CapabilityFailed", ).operation
rawCause?
Section titled “rawCause?”
readonlyoptionalrawCause?:unknown
Inherited from
Section titled “Inherited from”Data.TaggedError( "CapabilityFailed", ).rawCause
cause:
Readonly<{kind:"Files"|"Forage"|"InvalidInput"|"Unavailable"|"OperationFailed";message:string; }>
Inherited from
Section titled “Inherited from”Data.TaggedError( "CapabilityFailed", ).cause
Unknown
Section titled “Unknown”A foreign throw violated the typed adapter contract.
Extends
Section titled “Extends”YieldableError<this> &object&Readonly<SandboxFailureReference&object>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Unknown(
args):Unknown
Parameters
Section titled “Parameters”string
rawCause
Section titled “rawCause”unknown
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Data.TaggedError("Unknown")< SandboxFailureReference & { readonly rawCause: unknown; } >.constructor
Properties
Section titled “Properties”
readonlyoptionalref?:string
Inherited from
Section titled “Inherited from”Data.TaggedError("Unknown").ref
rawCause
Section titled “rawCause”
readonlyrawCause:unknown
Inherited from
Section titled “Inherited from”Data.TaggedError("Unknown").rawCause
Type Aliases
Section titled “Type Aliases”SandboxFailureReference
Section titled “SandboxFailureReference”SandboxFailureReference =
object
Optional source reference carried by sandbox failures.
Properties
Section titled “Properties”
readonlyoptionalref?:string
CapabilityDiagnostic
Section titled “CapabilityDiagnostic”CapabilityDiagnostic =
Readonly<{kind:"Files"|"Forage"|"InvalidInput"|"Unavailable"|"OperationFailed";message:string; }>
A capability owner explicitly admits this bounded diagnostic as safe.
CapabilityFailureFields
Section titled “CapabilityFailureFields”CapabilityFailureFields =
object
Fields admitted by a capability owner, with the original cause kept private.
Properties
Section titled “Properties”
readonlyoptionalref?:string
namespace
Section titled “namespace”
readonlynamespace:string
operation
Section titled “operation”
readonlyoperation:string
readonlycause:CapabilityDiagnostic
rawCause?
Section titled “rawCause?”
readonlyoptionalrawCause?:unknown
SandboxFailure
Section titled “SandboxFailure”SandboxFailure =
SourceInvalid|GuestThrew|DeadlineExceeded|Cancelled|DispatchLost|SandboxCrashed|BadResponse|ResultTooLarge|ResultNotJson|CapabilityFailed|Unknown
Closed error channel shared by sandbox adapters and the invocation owner.
Functions
Section titled “Functions”referenceSandboxFailure()
Section titled “referenceSandboxFailure()”referenceSandboxFailure(
failure,ref):SandboxFailure
Copy the failure to correlate one execution without mutating shared host errors.
Parameters
Section titled “Parameters”failure
Section titled “failure”string
Returns
Section titled “Returns”sandboxFailureMessage()
Section titled “sandboxFailureMessage()”sandboxFailureMessage(
failure,includeReference?):string
The sole model projection. Transport, parser and raw cause fields stay private.
Parameters
Section titled “Parameters”failure
Section titled “failure”includeReference?
Section titled “includeReference?”boolean = true
Returns
Section titled “Returns”string