@mndw/sdk / @mndw/sdk
@mndw/sdk
Classes
BackendBadGateway
Defined in: frontend/sdk/src/backend-client.ts:256
Extends
Constructors
Constructor
new BackendBadGateway(
id):BackendBadGateway
Defined in: frontend/sdk/src/backend-client.ts:259
Parameters
id
string
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"BAD_GATEWAY"='BAD_GATEWAY'
Defined in: frontend/sdk/src/backend-client.ts:257
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendBlocked
Defined in: frontend/sdk/src/backend-client.ts:243
Extends
Constructors
Constructor
new BackendBlocked(
id,blockers,retryAfterSeconds):BackendBlocked
Defined in: frontend/sdk/src/backend-client.ts:246
Parameters
id
string
blockers
object[]
retryAfterSeconds
number | null
Returns
Overrides
Properties
blockers
readonlyblockers:object[]
Defined in: frontend/sdk/src/backend-client.ts:248
permission
permission:
"persistent-rci-session:read"|"persistent-rci-session:write"=persistentRciPermissionSchema
prerequisite?
optionalprerequisite?:string
reason
reason:
string
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"BACKEND_BLOCKED"='BACKEND_BLOCKED'
Defined in: frontend/sdk/src/backend-client.ts:244
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
retryAfterSeconds
readonlyretryAfterSeconds:number|null
Defined in: frontend/sdk/src/backend-client.ts:249
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendDisabled
Defined in: frontend/sdk/src/backend-client.ts:189
Extends
Constructors
Constructor
new BackendDisabled(
id):BackendDisabled
Defined in: frontend/sdk/src/backend-client.ts:192
Parameters
id
string
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"DISABLED"='DISABLED'
Defined in: frontend/sdk/src/backend-client.ts:190
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendError
Defined in: frontend/sdk/src/backend-client.ts:159
Extends
Error
Extended by
BackendBadGatewayBackendBlockedBackendDisabledBackendIncompatibleBackendMaintenanceBackendNotApprovedBackendStartingBackendStatusQueryErrorBackendTransportMismatchBackendUnavailableBackendUnknownId
Constructors
Constructor
new BackendError(
message,code,id?):BackendError
Defined in: frontend/sdk/src/backend-client.ts:163
Parameters
message
string
code
id?
string
Returns
Overrides
Error.constructor
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.cause
code
readonlycode:BackendErrorCode
Defined in: frontend/sdk/src/backend-client.ts:161
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.message
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.name
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
Error.originalStack
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stack
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
Error.zoneAwareStack
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Error.stackTraceLimit
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
Error.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
BackendIncompatible
Defined in: frontend/sdk/src/backend-client.ts:225
Extends
Constructors
Constructor
new BackendIncompatible(
id):BackendIncompatible
Defined in: frontend/sdk/src/backend-client.ts:228
Parameters
id
string
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"BACKEND_INCOMPATIBLE"='BACKEND_INCOMPATIBLE'
Defined in: frontend/sdk/src/backend-client.ts:226
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendMaintenance
Defined in: frontend/sdk/src/backend-client.ts:234
Extends
Constructors
Constructor
new BackendMaintenance(
id,retryAfterSeconds):BackendMaintenance
Defined in: frontend/sdk/src/backend-client.ts:237
Parameters
id
string
retryAfterSeconds
number | null
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"BACKEND_MAINTENANCE"='BACKEND_MAINTENANCE'
Defined in: frontend/sdk/src/backend-client.ts:235
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
retryAfterSeconds
readonlyretryAfterSeconds:number|null
Defined in: frontend/sdk/src/backend-client.ts:237
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendNotApproved
Defined in: frontend/sdk/src/backend-client.ts:180
Extends
Constructors
Constructor
new BackendNotApproved(
id):BackendNotApproved
Defined in: frontend/sdk/src/backend-client.ts:183
Parameters
id
string
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"NOT_APPROVED"='NOT_APPROVED'
Defined in: frontend/sdk/src/backend-client.ts:181
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendStarting
Defined in: frontend/sdk/src/backend-client.ts:207
Extends
Constructors
Constructor
new BackendStarting(
id,retryAfterSeconds):BackendStarting
Defined in: frontend/sdk/src/backend-client.ts:210
Parameters
id
string
retryAfterSeconds
number | null
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"BACKEND_STARTING"='BACKEND_STARTING'
Defined in: frontend/sdk/src/backend-client.ts:208
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
retryAfterSeconds
readonlyretryAfterSeconds:number|null
Defined in: frontend/sdk/src/backend-client.ts:210
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendStatusQueryError
Defined in: frontend/sdk/src/backend-client.ts:265
Extends
Constructors
Constructor
new BackendStatusQueryError(
httpStatus,message):BackendStatusQueryError
Defined in: frontend/sdk/src/backend-client.ts:268
Parameters
httpStatus
number | null
message
string
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"STATUS_QUERY_FAILED"='STATUS_QUERY_FAILED'
Defined in: frontend/sdk/src/backend-client.ts:266
Overrides
httpStatus
readonlyhttpStatus:number|null
Defined in: frontend/sdk/src/backend-client.ts:268
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendTransportMismatch
Defined in: frontend/sdk/src/backend-client.ts:198
Extends
Constructors
Constructor
new BackendTransportMismatch(
id,expected):BackendTransportMismatch
Defined in: frontend/sdk/src/backend-client.ts:201
Parameters
id
string
expected
BackendRouteTransport
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"TRANSPORT_MISMATCH"='TRANSPORT_MISMATCH'
Defined in: frontend/sdk/src/backend-client.ts:199
Overrides
expected
readonlyexpected:BackendRouteTransport
Defined in: frontend/sdk/src/backend-client.ts:201
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendUnavailable
Defined in: frontend/sdk/src/backend-client.ts:216
Extends
Constructors
Constructor
new BackendUnavailable(
id):BackendUnavailable
Defined in: frontend/sdk/src/backend-client.ts:219
Parameters
id
string
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"BACKEND_UNAVAILABLE"='BACKEND_UNAVAILABLE'
Defined in: frontend/sdk/src/backend-client.ts:217
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
BackendUnknownId
Defined in: frontend/sdk/src/backend-client.ts:171
Extends
Constructors
Constructor
new BackendUnknownId(
id):BackendUnknownId
Defined in: frontend/sdk/src/backend-client.ts:174
Parameters
id
string
Returns
Overrides
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
code
readonlycode:"UNKNOWN_ID"='UNKNOWN_ID'
Defined in: frontend/sdk/src/backend-client.ts:172
Overrides
id
readonlyid:string|undefined
Defined in: frontend/sdk/src/backend-client.ts:160
Inherited from
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
BackendError.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
BackendError.prepareStackTrace
PageRouteError
Defined in: frontend/sdk/src/context.ts:37
Extends
Error
Constructors
Constructor
new PageRouteError(
code,message,options?):PageRouteError
Defined in: frontend/sdk/src/context.ts:40
Parameters
code
message
string
options?
ErrorOptions
Returns
Overrides
Error.constructor
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.cause
code
readonlycode:PageRouteErrorCode
Defined in: frontend/sdk/src/context.ts:38
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.message
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.name
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
Error.originalStack
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stack
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
Error.zoneAwareStack
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Error.stackTraceLimit
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
Error.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
TelemetryError
Defined in: frontend/sdk/src/telemetry-client.ts:81
Extends
Error
Constructors
Constructor
new TelemetryError(
status,message):TelemetryError
Defined in: frontend/sdk/src/telemetry-client.ts:84
Parameters
status
number
message
string
Returns
Overrides
Error.constructor
Properties
cause?
optionalcause?:unknown
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Error.cause
message
message:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Error.message
name
name:
string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Error.name
originalStack?
optionaloriginalStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:38
Original stack trace with no modifications
Inherited from
Error.originalStack
stack?
optionalstack?:string
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Error.stack
status
readonlystatus:number
Defined in: frontend/sdk/src/telemetry-client.ts:82
zoneAwareStack?
optionalzoneAwareStack?:string
Defined in: node_modules/.pnpm/zone.js@0.15.1/node_modules/zone.js/lib/zone.d.ts:34
Stack trace where extra frames have been removed and zone names added.
Inherited from
Error.zoneAwareStack
stackTraceLimit
staticstackTraceLimit:number
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:68
The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Error.stackTraceLimit
Methods
captureStackTrace()
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:52
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.
The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
targetObject
object
constructorOpt?
Function
Returns
void
Inherited from
Error.captureStackTrace
prepareStackTrace()
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/.pnpm/@types+node@22.19.15/node_modules/@types/node/globals.d.ts:56
Parameters
err
Error
stackTraces
CallSite[]
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
Interfaces
BackendClient
Defined in: frontend/sdk/src/backend-client.ts:127
Methods
fetch()
fetch(
id,options?):Promise<Response>
Defined in: frontend/sdk/src/backend-client.ts:129
Resolve id to its URL + method and issue the request. Throws BackendUnknownId synchronously.
Parameters
id
string
options?
Returns
Promise<Response>
socket()
socket(
id,options?):WebSocket
Defined in: frontend/sdk/src/backend-client.ts:131
Open a websocket to the declared target. Throws synchronously on a bad/blocked id.
Parameters
id
string
options?
Returns
WebSocket
status()
status(
options?):Promise<{blockers:object[];kind:"exec"|"service";retryAfterSeconds:number|null;state:"blocked"; } | {kind:"exec"|"service";requiredProtocol:number;retryAfterSeconds:number|null;state:"incompatible";supportedProtocols:number[]; } | {kind:"exec"|"service";retryAfterSeconds:number|null;state:"ready"|"starting"|"unavailable"|"maintenance"|"disabled"|"not-approved"; }>
Defined in: frontend/sdk/src/backend-client.ts:133
Query live daemon-owned backend availability without executing a backend route.
Parameters
options?
Returns
Promise<{ blockers: object[]; kind: "exec" | "service"; retryAfterSeconds: number | null; state: "blocked"; } | { kind: "exec" | "service"; requiredProtocol: number; retryAfterSeconds: number | null; state: "incompatible"; supportedProtocols: number[]; } | { kind: "exec" | "service"; retryAfterSeconds: number | null; state: "ready" | "starting" | "unavailable" | "maintenance" | "disabled" | "not-approved"; }>
BackendFetchOptions
Defined in: frontend/sdk/src/backend-client.ts:116
Properties
body?
optionalbody?:Record<string,unknown> |unknown[] |BodyInit|null
Defined in: frontend/sdk/src/backend-client.ts:118
headers?
optionalheaders?:HeadersInit
Defined in: frontend/sdk/src/backend-client.ts:119
query?
optionalquery?:Record<string,string|number|boolean>
Defined in: frontend/sdk/src/backend-client.ts:117
signal?
optionalsignal?:AbortSignal
Defined in: frontend/sdk/src/backend-client.ts:120
BackendSocketOptions
Defined in: frontend/sdk/src/backend-client.ts:123
Properties
protocols?
optionalprotocols?:string[]
Defined in: frontend/sdk/src/backend-client.ts:124
BackendStatusOptions
Defined in: frontend/sdk/src/backend-client.ts:112
Properties
signal?
optionalsignal?:AbortSignal
Defined in: frontend/sdk/src/backend-client.ts:113
DeviceInfo
Defined in: frontend/sdk/src/context.ts:98
Plugin-facing device data with helpers bound to one context snapshot.
Extends
Properties
architecture?
readonlyoptionalarchitecture?:string
Defined in: frontend/sdk/src/context.ts:90
show.version.arch; absent when host information was unavailable.
Inherited from
components
readonlycomponents: readonlystring[]
Defined in: frontend/sdk/src/context.ts:92
Inherited from
deviceName
readonlydeviceName:string
Defined in: frontend/sdk/src/context.ts:76
Inherited from
features
readonlyfeatures: readonlystring[]
Defined in: frontend/sdk/src/context.ts:91
Inherited from
firmwareRelease
readonlyfirmwareRelease:string
Defined in: frontend/sdk/src/context.ts:88
show.version.release.
Inherited from
DeviceInfoData.firmwareRelease
firmwareVersion
readonlyfirmwareVersion:string
Defined in: frontend/sdk/src/context.ts:86
show.version.title.
Inherited from
DeviceInfoData.firmwareVersion
hwId
readonlyhwId:string
Defined in: frontend/sdk/src/context.ts:82
Inherited from
hwType?
readonlyoptionalhwType?:string
Defined in: frontend/sdk/src/context.ts:84
Inherited from
hwVersion
readonlyhwVersion:string
Defined in: frontend/sdk/src/context.ts:83
Inherited from
manufacturer
readonlymanufacturer:string
Defined in: frontend/sdk/src/context.ts:78
Inherited from
model
readonlymodel:string
Defined in: frontend/sdk/src/context.ts:79
Inherited from
region
readonlyregion:string
Defined in: frontend/sdk/src/context.ts:81
Inherited from
series
readonlyseries:string
Defined in: frontend/sdk/src/context.ts:80
Inherited from
switchports
readonlyswitchports:Switchports
Defined in: frontend/sdk/src/context.ts:93
Inherited from
usb
readonlyusb:DeviceUsb
Defined in: frontend/sdk/src/context.ts:94
Inherited from
vendor
readonlyvendor:string
Defined in: frontend/sdk/src/context.ts:77
Inherited from
Methods
hasComponent()
hasComponent(
name):boolean
Defined in: frontend/sdk/src/context.ts:100
Parameters
name
string
Returns
boolean
hasFeature()
hasFeature(
name):boolean
Defined in: frontend/sdk/src/context.ts:99
Parameters
name
string
Returns
boolean
DeviceInfoData
Defined in: frontend/sdk/src/context.ts:75
Plain, serializable device data without context-bound helper methods.
Extended by
Properties
architecture?
readonlyoptionalarchitecture?:string
Defined in: frontend/sdk/src/context.ts:90
show.version.arch; absent when host information was unavailable.
components
readonlycomponents: readonlystring[]
Defined in: frontend/sdk/src/context.ts:92
deviceName
readonlydeviceName:string
Defined in: frontend/sdk/src/context.ts:76
features
readonlyfeatures: readonlystring[]
Defined in: frontend/sdk/src/context.ts:91
firmwareRelease
readonlyfirmwareRelease:string
Defined in: frontend/sdk/src/context.ts:88
show.version.release.
firmwareVersion
readonlyfirmwareVersion:string
Defined in: frontend/sdk/src/context.ts:86
show.version.title.
hwId
readonlyhwId:string
Defined in: frontend/sdk/src/context.ts:82
hwType?
readonlyoptionalhwType?:string
Defined in: frontend/sdk/src/context.ts:84
hwVersion
readonlyhwVersion:string
Defined in: frontend/sdk/src/context.ts:83
manufacturer
readonlymanufacturer:string
Defined in: frontend/sdk/src/context.ts:78
model
readonlymodel:string
Defined in: frontend/sdk/src/context.ts:79
region
readonlyregion:string
Defined in: frontend/sdk/src/context.ts:81
series
readonlyseries:string
Defined in: frontend/sdk/src/context.ts:80
switchports
readonlyswitchports:Switchports
Defined in: frontend/sdk/src/context.ts:93
usb
readonlyusb:DeviceUsb
Defined in: frontend/sdk/src/context.ts:94
vendor
readonlyvendor:string
Defined in: frontend/sdk/src/context.ts:77
DeviceUsb
Defined in: frontend/sdk/src/context.ts:69
Properties
ports
readonlyports: readonly ("usb2"|"usb3")[]
Defined in: frontend/sdk/src/context.ts:71
USB version per physical port, ordered by physical position. Empty when the device has no USB.
HostNavigation
Defined in: frontend/sdk/src/context.ts:32
Methods
href()
href(
target):string|undefined
Defined in: frontend/sdk/src/context.ts:33
Parameters
target
Returns
string | undefined
navigate()
navigate(
target):boolean
Defined in: frontend/sdk/src/context.ts:34
Parameters
target
Returns
boolean
MndwPlugin
Defined in: frontend/sdk/src/plugin.ts:15
Methods
createInstance()
createInstance(
container,context):PluginInstance|Promise<PluginInstance>
Defined in: frontend/sdk/src/plugin.ts:16
Parameters
container
HTMLElement
context
Returns
PluginInstance | Promise<PluginInstance>
OverlayAnchor
Defined in: frontend/sdk/src/overlay.ts:39
Properties
element
element:
HTMLElement
Defined in: frontend/sdk/src/overlay.ts:40
OverlayCloseEvent
Defined in: frontend/sdk/src/overlay.ts:43
Type Parameters
Result
Result = unknown
Properties
reason
reason:
OverlayCloseReason
Defined in: frontend/sdk/src/overlay.ts:44
result?
optionalresult?:Result
Defined in: frontend/sdk/src/overlay.ts:45
OverlayLayer
Defined in: frontend/sdk/src/overlay.ts:65
Extended by
Type Parameters
Result
Result = unknown
Properties
closed
readonlyclosed:Promise<OverlayCloseEvent<Result>>
Defined in: frontend/sdk/src/overlay.ts:72
contentElement
readonlycontentElement:HTMLElement
Defined in: frontend/sdk/src/overlay.ts:68
Plugin mount target. For open() this is the shell body slot.
hostElement
readonlyhostElement:HTMLElement
Defined in: frontend/sdk/src/overlay.ts:66
isOpen
readonlyisOpen:boolean
Defined in: frontend/sdk/src/overlay.ts:70
Convenience: true while state is 'opening' or 'open'.
signal
readonlysignal:AbortSignal
Defined in: frontend/sdk/src/overlay.ts:74
Aborts when closing starts. Same object is passed to the open() mount callback.
state
readonlystate:"opening"|"open"|"closing"|"closed"
Defined in: frontend/sdk/src/overlay.ts:71
Methods
close()
close(
result?,reason?):void
Defined in: frontend/sdk/src/overlay.ts:77
Idempotent; valid in any state except closed. reason defaults to 'api'.
Parameters
result?
Result
reason?
"api" | "action"
Returns
void
markReady()
markReady():
void
Defined in: frontend/sdk/src/overlay.ts:81
Signal the layer is safe for interaction; moves state to open.
Returns
void
onClose()
onClose(
listener): () =>void
Defined in: frontend/sdk/src/overlay.ts:90
Parameters
listener
(event) => void
Returns
() => void
setCleanup()
setCleanup(
cleanup):void
Defined in: frontend/sdk/src/overlay.ts:79
Register teardown as part of setup. Last call before closing wins.
Parameters
cleanup
Promise<() => void | Promise<void>> | (() => void | Promise<void>)
Returns
void
update()
update(
options):void
Defined in: frontend/sdk/src/overlay.ts:82
Parameters
options
Partial<Pick<OverlayLayerOptions, "placement" | "anchor" | "className" | "width" | "height" | "maxWidth" | "maxHeight">>
Returns
void
OverlayLayerOptions
Defined in: frontend/sdk/src/overlay.ts:48
Properties
anchor?
optionalanchor?:OverlayAnchor
Defined in: frontend/sdk/src/overlay.ts:50
className?
optionalclassName?:string
Defined in: frontend/sdk/src/overlay.ts:62
Applied to hostElement only. Host-owned shell internals stay host-controlled.
closeOnEscape?
optionalcloseOnEscape?:boolean
Defined in: frontend/sdk/src/overlay.ts:56
closeOnOutsideClick?
optionalcloseOnOutsideClick?:boolean
Defined in: frontend/sdk/src/overlay.ts:57
height?
optionalheight?:string|number
Defined in: frontend/sdk/src/overlay.ts:53
kind
kind:
OverlayKind
Defined in: frontend/sdk/src/overlay.ts:49
lockScroll?
optionallockScroll?:boolean
Defined in: frontend/sdk/src/overlay.ts:60
maxHeight?
optionalmaxHeight?:string|number
Defined in: frontend/sdk/src/overlay.ts:55
maxWidth?
optionalmaxWidth?:string|number
Defined in: frontend/sdk/src/overlay.ts:54
placement?
optionalplacement?:OverlayPlacement
Defined in: frontend/sdk/src/overlay.ts:51
restoreFocus?
optionalrestoreFocus?:boolean
Defined in: frontend/sdk/src/overlay.ts:59
trapFocus?
optionaltrapFocus?:boolean
Defined in: frontend/sdk/src/overlay.ts:58
width?
optionalwidth?:string|number
Defined in: frontend/sdk/src/overlay.ts:52
OverlayOpenOptions
Defined in: frontend/sdk/src/overlay.ts:99
Extends
Omit<OverlayLayerOptions,"kind"|"anchor">
Type Parameters
Result
Result = unknown
Properties
className?
optionalclassName?:string
Defined in: frontend/sdk/src/overlay.ts:62
Applied to hostElement only. Host-owned shell internals stay host-controlled.
Inherited from
closeOnEscape?
optionalcloseOnEscape?:boolean
Defined in: frontend/sdk/src/overlay.ts:56
Inherited from
OverlayLayerOptions.closeOnEscape
closeOnOutsideClick?
optionalcloseOnOutsideClick?:boolean
Defined in: frontend/sdk/src/overlay.ts:57
Inherited from
OverlayLayerOptions.closeOnOutsideClick
description?
optionaldescription?:string
Defined in: frontend/sdk/src/overlay.ts:102
height?
optionalheight?:string|number
Defined in: frontend/sdk/src/overlay.ts:53
Inherited from
kind
kind:
"modal"|"drawer"
Defined in: frontend/sdk/src/overlay.ts:100
lockScroll?
optionallockScroll?:boolean
Defined in: frontend/sdk/src/overlay.ts:60
Inherited from
OverlayLayerOptions.lockScroll
maxHeight?
optionalmaxHeight?:string|number
Defined in: frontend/sdk/src/overlay.ts:55
Inherited from
maxWidth?
optionalmaxWidth?:string|number
Defined in: frontend/sdk/src/overlay.ts:54
Inherited from
mount
mount:
OverlayMount<Result>
Defined in: frontend/sdk/src/overlay.ts:104
placement?
optionalplacement?:OverlayPlacement
Defined in: frontend/sdk/src/overlay.ts:51
Inherited from
restoreFocus?
optionalrestoreFocus?:boolean
Defined in: frontend/sdk/src/overlay.ts:59
Inherited from
OverlayLayerOptions.restoreFocus
showCloseButton?
optionalshowCloseButton?:boolean
Defined in: frontend/sdk/src/overlay.ts:103
title?
optionaltitle?:string
Defined in: frontend/sdk/src/overlay.ts:101
trapFocus?
optionaltrapFocus?:boolean
Defined in: frontend/sdk/src/overlay.ts:58
Inherited from
width?
optionalwidth?:string|number
Defined in: frontend/sdk/src/overlay.ts:52
Inherited from
OverlayService
Defined in: frontend/sdk/src/overlay.ts:126
Methods
closeAll()
closeAll():
void
Defined in: frontend/sdk/src/overlay.ts:130
Closes all overlays opened by this plugin instance with reason 'api'.
Returns
void
createLayer()
createLayer<
Result>(options):OverlayLayer<Result>
Defined in: frontend/sdk/src/overlay.ts:127
Type Parameters
Result
Result = unknown
Parameters
options
Returns
OverlayLayer<Result>
open()
open<
Result>(options):OverlaySession<Result>
Defined in: frontend/sdk/src/overlay.ts:128
Type Parameters
Result
Result = unknown
Parameters
options
OverlayOpenOptions<Result>
Returns
OverlaySession<Result>
OverlaySession
Defined in: frontend/sdk/src/overlay.ts:107
Extends
OverlayLayer<Result>
Type Parameters
Result
Result = unknown
Properties
closed
readonlyclosed:Promise<OverlayCloseEvent<Result>>
Defined in: frontend/sdk/src/overlay.ts:72
Inherited from
contentElement
readonlycontentElement:HTMLElement
Defined in: frontend/sdk/src/overlay.ts:68
Plugin mount target. For open() this is the shell body slot.
Inherited from
hostElement
readonlyhostElement:HTMLElement
Defined in: frontend/sdk/src/overlay.ts:66
Inherited from
isOpen
readonlyisOpen:boolean
Defined in: frontend/sdk/src/overlay.ts:70
Convenience: true while state is 'opening' or 'open'.
Inherited from
signal
readonlysignal:AbortSignal
Defined in: frontend/sdk/src/overlay.ts:74
Aborts when closing starts. Same object is passed to the open() mount callback.
Inherited from
state
readonlystate:"opening"|"open"|"closing"|"closed"
Defined in: frontend/sdk/src/overlay.ts:71
Inherited from
Methods
close()
close(
result?,reason?):void
Defined in: frontend/sdk/src/overlay.ts:77
Idempotent; valid in any state except closed. reason defaults to 'api'.
Parameters
result?
Result
reason?
"api" | "action"
Returns
void
Inherited from
markReady()
markReady():
void
Defined in: frontend/sdk/src/overlay.ts:81
Signal the layer is safe for interaction; moves state to open.
Returns
void
Inherited from
onClose()
onClose(
listener): () =>void
Defined in: frontend/sdk/src/overlay.ts:90
Parameters
listener
(event) => void
Returns
() => void
Inherited from
setCleanup()
setCleanup(
cleanup):void
Defined in: frontend/sdk/src/overlay.ts:79
Register teardown as part of setup. Last call before closing wins.
Parameters
cleanup
Promise<() => void | Promise<void>> | (() => void | Promise<void>)
Returns
void
Inherited from
update()
update(
options):void
Defined in: frontend/sdk/src/overlay.ts:108
Parameters
options
Partial<Pick<OverlayOpenOptions<Result>, "title" | "description" | "showCloseButton" | "width" | "height" | "maxWidth" | "maxHeight" | "placement" | "className">>
Returns
void
Overrides
PagePluginContext
Defined in: frontend/sdk/src/context.ts:144
Extends
PluginContextBase
Properties
backend?
optionalbackend?:BackendClient
Defined in: frontend/sdk/src/context.ts:129
Typed backend client. Present only when the plugin declares a backend; ids resolve locally from the daemon's descriptor snapshot. See BackendClient.
Inherited from
PluginContextBase.backend
deviceInfo
deviceInfo:
DeviceInfo
Defined in: frontend/sdk/src/context.ts:110
Inherited from
PluginContextBase.deviceInfo
events?
optionalevents?:PluginEventFacade
Defined in: frontend/sdk/src/context.ts:106
Inherited from
PluginContextBase.events
i18n
i18n:
PluginI18n
Defined in: frontend/sdk/src/context.ts:111
Inherited from
PluginContextBase.i18n
instanceId
instanceId:
string
Defined in: frontend/sdk/src/context.ts:112
Inherited from
PluginContextBase.instanceId
kind
readonlykind:"page"
Defined in: frontend/sdk/src/context.ts:145
locale
readonlylocale:string
Defined in: frontend/sdk/src/context.ts:118
Current host locale. This getter follows changes while the plugin is mounted.
Inherited from
PluginContextBase.locale
locale$
readonlylocale$:Observable<string>
Defined in: frontend/sdk/src/context.ts:120
Emits the current locale on subscribe and completes when the plugin unmounts.
Inherited from
PluginContextBase.locale$
navigation
readonlynavigation:HostNavigation
Defined in: frontend/sdk/src/context.ts:104
Inherited from
PluginContextBase.navigation
overlay
overlay:
OverlayService
Defined in: frontend/sdk/src/context.ts:131
Framework-agnostic top-layer UI (modal, drawer, popover, custom).
Inherited from
PluginContextBase.overlay
pageRoute
readonlypageRoute:PageRoute
Defined in: frontend/sdk/src/context.ts:147
Navigate within the plugin's page route.
palette
readonlypalette:PaletteTokenMap
Defined in: frontend/sdk/src/context.ts:122
Current applied palette, including a device override when present.
Inherited from
PluginContextBase.palette
palette$
readonlypalette$:Observable<PaletteTokenMap>
Defined in: frontend/sdk/src/context.ts:124
Emits the current palette on subscribe and completes when the plugin unmounts.
Inherited from
PluginContextBase.palette$
rciManager
rciManager:
PluginRciManager
Defined in: frontend/sdk/src/context.ts:107
Inherited from
PluginContextBase.rciManager
setTileTitle?
readonlyoptionalsetTileTitle?:undefined
Defined in: frontend/sdk/src/context.ts:149
Page plugins do not receive a dashboard tile title setter.
sharedStorage
sharedStorage:
PluginStorage
Defined in: frontend/sdk/src/context.ts:109
Inherited from
PluginContextBase.sharedStorage
storage
storage:
PluginStorage
Defined in: frontend/sdk/src/context.ts:108
Inherited from
PluginContextBase.storage
telemetry
readonlytelemetry:PluginTelemetry
Defined in: frontend/sdk/src/context.ts:105
Inherited from
PluginContextBase.telemetry
theme
readonlytheme:"light"|"dark"
Defined in: frontend/sdk/src/context.ts:114
Current host theme. This getter follows changes while the plugin is mounted.
Inherited from
PluginContextBase.theme
theme$
readonlytheme$:Observable<"light"|"dark">
Defined in: frontend/sdk/src/context.ts:116
Emits the current theme on subscribe and completes when the plugin unmounts.
Inherited from
PluginContextBase.theme$
Methods
createTicker()
createTicker():
Ticker
Defined in: frontend/sdk/src/context.ts:133
Creates a host-managed ticker destroyed when this plugin context ends.
Returns
Inherited from
PluginContextBase.createTicker
PageRoute
Defined in: frontend/sdk/src/context.ts:13
Properties
childPath$
readonlychildPath$:Observable<string>
Defined in: frontend/sdk/src/context.ts:14
Methods
navigate()
navigate(
childPath,options?):Promise<void>
Defined in: frontend/sdk/src/context.ts:15
Parameters
childPath
string
options?
replace?
boolean
scrollToTop?
boolean
Returns
Promise<void>
PluginEventFacade
Defined in: frontend/sdk/src/event-schema.ts:224
Properties
resync$
readonlyresync$:Observable<void>
Defined in: frontend/sdk/src/event-schema.ts:226
Methods
select$()
select$(
topics):Observable<{id:string;payload:Record<string,unknown>;source:unknown;topic:"wan.connected";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"wan.disconnected";ts:number; } | {id:string;payload: {address:string;connected:boolean;link:string;mask:string; };source:unknown;topic:"net.ip_changed";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"net.dhcp_lease";ts:number; } | {id:string;payload: {resolvers:string[]; };source:unknown;topic:"net.dns_changed";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"wifi.client_join";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"wifi.client_leave";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"firewall.rebuilt";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"usb.attached";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"usb.detached";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"fs.mounted";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"fs.unmounted";ts:number; } | {id:string;payload: {offset_ms?:number; };source:unknown;topic:"clock.synced";ts:number; } | {id:string;payload: {action:string;elapsed:number;name:string; };source:unknown;topic:"schedule.fired";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"button.pressed";ts:number; } | {id:string;payload: {ip:string;success:boolean;user:string; };source:unknown;topic:"auth.login";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"firmware.available";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"plugin.installed";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"plugin.removed";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"plugin.approved";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"plugin.started";ts:number; } | {id:string;payload: {name:string;reason:string; };source:unknown;topic:"plugin.stopped";ts:number; } | {id:string;payload: {uptime_ms:number;version:string; };source:unknown;topic:"daemon.started";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"daemon.stopping";ts:number; } | {id:string;payload:Record<string,unknown>;source:unknown;topic:"daemon.updated";ts:number; } | {id:string;payload: {available_bytes:number;path:"/opt";threshold_bytes:number; };source:unknown;topic:"storage.low";ts:number; } | {id:string;payload: {enabled:boolean; };source:unknown;topic:"telemetry.gathering_changed";ts:number; }>
Defined in: frontend/sdk/src/event-schema.ts:225
Parameters
topics
string | readonly string[]
Returns
Observable<{ id: string; payload: Record<string, unknown>; source: unknown; topic: "wan.connected"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "wan.disconnected"; ts: number; } | { id: string; payload: { address: string; connected: boolean; link: string; mask: string; }; source: unknown; topic: "net.ip_changed"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "net.dhcp_lease"; ts: number; } | { id: string; payload: { resolvers: string[]; }; source: unknown; topic: "net.dns_changed"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "wifi.client_join"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "wifi.client_leave"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "firewall.rebuilt"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "usb.attached"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "usb.detached"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "fs.mounted"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "fs.unmounted"; ts: number; } | { id: string; payload: { offset_ms?: number; }; source: unknown; topic: "clock.synced"; ts: number; } | { id: string; payload: { action: string; elapsed: number; name: string; }; source: unknown; topic: "schedule.fired"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "button.pressed"; ts: number; } | { id: string; payload: { ip: string; success: boolean; user: string; }; source: unknown; topic: "auth.login"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "firmware.available"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "plugin.installed"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "plugin.removed"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "plugin.approved"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "plugin.started"; ts: number; } | { id: string; payload: { name: string; reason: string; }; source: unknown; topic: "plugin.stopped"; ts: number; } | { id: string; payload: { uptime_ms: number; version: string; }; source: unknown; topic: "daemon.started"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "daemon.stopping"; ts: number; } | { id: string; payload: Record<string, unknown>; source: unknown; topic: "daemon.updated"; ts: number; } | { id: string; payload: { available_bytes: number; path: "/opt"; threshold_bytes: number; }; source: unknown; topic: "storage.low"; ts: number; } | { id: string; payload: { enabled: boolean; }; source: unknown; topic: "telemetry.gathering_changed"; ts: number; }>
PluginI18n
Defined in: frontend/sdk/src/i18n.ts:8
Extended by
Properties
change$
readonlychange$:Observable<void>
Defined in: frontend/sdk/src/i18n.ts:14
direction
readonlydirection:"ltr"
Defined in: frontend/sdk/src/i18n.ts:10
locale
readonlylocale:string
Defined in: frontend/sdk/src/i18n.ts:9
Methods
formatDate()
formatDate(
value,options?):string
Defined in: frontend/sdk/src/i18n.ts:13
Parameters
value
Date
options?
DateTimeFormatOptions
Returns
string
formatNumber()
formatNumber(
value,options?):string
Defined in: frontend/sdk/src/i18n.ts:12
Parameters
value
number
options?
NumberFormatOptions
Returns
string
t()
t(
key,values?):string
Defined in: frontend/sdk/src/i18n.ts:11
Parameters
key
string
values?
Record<string, unknown>
Returns
string
PluginInstance
Defined in: frontend/sdk/src/plugin.ts:9
Methods
onResize()?
optionalonResize(size):void
Defined in: frontend/sdk/src/plugin.ts:12
Called on tile resize with the new size in grid units. Widgets only.
Parameters
size
Returns
void
unmount()
unmount():
void|Promise<void>
Defined in: frontend/sdk/src/plugin.ts:10
Returns
void | Promise<void>
PluginResizeSize
Defined in: frontend/sdk/src/plugin.ts:4
Widget tile size in grid units, passed to onResize.
Properties
h
h:
number
Defined in: frontend/sdk/src/plugin.ts:6
w
w:
number
Defined in: frontend/sdk/src/plugin.ts:5
PluginStorage
Defined in: frontend/sdk/src/storage.ts:1
Methods
delete()
delete(
key):Promise<void>
Defined in: frontend/sdk/src/storage.ts:4
Parameters
key
string
Returns
Promise<void>
get()
get(
key):Promise<string|null>
Defined in: frontend/sdk/src/storage.ts:2
Parameters
key
string
Returns
Promise<string | null>
keys()
keys():
Promise<string[]>
Defined in: frontend/sdk/src/storage.ts:5
Returns
Promise<string[]>
set()
set(
key,value):Promise<void>
Defined in: frontend/sdk/src/storage.ts:3
Parameters
key
string
value
string
Returns
Promise<void>
PluginTelemetry
Defined in: frontend/sdk/src/telemetry-client.ts:76
Extends
Properties
gathering$
readonlygathering$:Observable<TelemetryGathering>
Defined in: frontend/sdk/src/telemetry-client.ts:78
Emits the current gathering state once it is known, then every change; completes on unmount.
Methods
fetchProjected()
fetchProjected(
range,options?):Promise<ProjectedSnapshot>
Defined in: frontend/sdk/src/telemetry-client.ts:69
Parameters
range
options?
signal?
AbortSignal
Returns
Promise<ProjectedSnapshot>
Inherited from
TelemetryClient.fetchProjected
ProjectedBand
Defined in: frontend/sdk/src/telemetry-client.ts:31
Properties
color
readonlycolor:ProjectedChartColor
Defined in: frontend/sdk/src/telemetry-client.ts:34
data
readonlydata: readonlyProjectedBandPoint[]
Defined in: frontend/sdk/src/telemetry-client.ts:33
id
readonlyid:string
Defined in: frontend/sdk/src/telemetry-client.ts:32
ProjectedBandPoint
Defined in: frontend/sdk/src/telemetry-client.ts:25
Properties
max
readonlymax:number
Defined in: frontend/sdk/src/telemetry-client.ts:28
min
readonlymin:number
Defined in: frontend/sdk/src/telemetry-client.ts:27
time
readonlytime:number
Defined in: frontend/sdk/src/telemetry-client.ts:26
ProjectedPoint
Defined in: frontend/sdk/src/telemetry-client.ts:14
Properties
time
readonlytime:number
Defined in: frontend/sdk/src/telemetry-client.ts:15
value
readonlyvalue:number
Defined in: frontend/sdk/src/telemetry-client.ts:16
ProjectedSegment
Defined in: frontend/sdk/src/telemetry-client.ts:21
Properties
data
readonlydata: readonlyProjectedPoint[]
Defined in: frontend/sdk/src/telemetry-client.ts:22
ProjectedSeries
Defined in: frontend/sdk/src/telemetry-client.ts:51
Properties
bands
readonlybands: readonlyProjectedBand[]
Defined in: frontend/sdk/src/telemetry-client.ts:57
label?
readonlyoptionallabel?:string
Defined in: frontend/sdk/src/telemetry-client.ts:52
points
readonlypoints: readonlyProjectedPoint[]
Defined in: frontend/sdk/src/telemetry-client.ts:55
segments
readonlysegments: readonlyProjectedSegment[]
Defined in: frontend/sdk/src/telemetry-client.ts:56
supported
readonlysupported:boolean
Defined in: frontend/sdk/src/telemetry-client.ts:53
unit
readonlyunit:TelemetryUnit
Defined in: frontend/sdk/src/telemetry-client.ts:54
valueDomain?
readonlyoptionalvalueDomain?:ProjectedValueDomain
Defined in: frontend/sdk/src/telemetry-client.ts:58
ProjectedSnapshot
Defined in: frontend/sdk/src/telemetry-client.ts:61
Properties
clock?
readonlyoptionalclock?:TelemetryClock
Defined in: frontend/sdk/src/telemetry-client.ts:64
gathering
readonlygathering:object
Defined in: frontend/sdk/src/telemetry-client.ts:63
enabled
readonlyenabled:boolean
keys
readonlykeys:Readonly<Record<string,ProjectedSeries>>
Defined in: frontend/sdk/src/telemetry-client.ts:62
sessionConfigured
readonlysessionConfigured:boolean
Defined in: frontend/sdk/src/telemetry-client.ts:65
ProjectedValueDomain
Defined in: frontend/sdk/src/telemetry-client.ts:37
Properties
max
readonlymax:number
Defined in: frontend/sdk/src/telemetry-client.ts:39
min
readonlymin:number
Defined in: frontend/sdk/src/telemetry-client.ts:38
Switchport
Defined in: frontend/sdk/src/context.ts:47
Properties
color
readonlycolor:string
Defined in: frontend/sdk/src/context.ts:57
group
readonlygroup:string
Defined in: frontend/sdk/src/context.ts:56
Port group, e.g. "WAN" or "LAN".
id
readonlyid:string
Defined in: frontend/sdk/src/context.ts:49
Stable port key, e.g. "WAN", "LAN1".
index
readonlyindex:number
Defined in: frontend/sdk/src/context.ts:52
interfaceId
readonlyinterfaceId:string
Defined in: frontend/sdk/src/context.ts:58
label
readonlylabel:string
Defined in: frontend/sdk/src/context.ts:51
Physical label printed on the case, e.g. "0".."3".
type
readonlytype:string
Defined in: frontend/sdk/src/context.ts:54
Port medium, e.g. "ethernet".
Switchports
Defined in: frontend/sdk/src/context.ts:61
Properties
hasPortStats
readonlyhasPortStats:boolean
Defined in: frontend/sdk/src/context.ts:66
layout
readonlylayout: readonly (readonlystring[])[]
Defined in: frontend/sdk/src/context.ts:65
Physical rows of switchport labels for drawing the device body.
list
readonlylist: readonlySwitchport[]
Defined in: frontend/sdk/src/context.ts:63
Ordered by index.
TelemetryClient
Defined in: frontend/sdk/src/telemetry-client.ts:68
Extended by
Methods
fetchProjected()
fetchProjected(
range,options?):Promise<ProjectedSnapshot>
Defined in: frontend/sdk/src/telemetry-client.ts:69
Parameters
range
options?
signal?
AbortSignal
Returns
Promise<ProjectedSnapshot>
TelemetryClock
Defined in: frontend/sdk/src/telemetry-client.ts:5
Properties
historyCurrent
readonlyhistoryCurrent:boolean
Defined in: frontend/sdk/src/telemetry-client.ts:8
historyEndMs
readonlyhistoryEndMs:number|null
Defined in: frontend/sdk/src/telemetry-client.ts:7
replayPending
readonlyreplayPending:boolean
Defined in: frontend/sdk/src/telemetry-client.ts:9
state
readonlystate:TelemetryClockState
Defined in: frontend/sdk/src/telemetry-client.ts:6
TelemetryGathering
Defined in: frontend/sdk/src/telemetry-client.ts:72
Properties
enabled
readonlyenabled:boolean
Defined in: frontend/sdk/src/telemetry-client.ts:73
Ticker
Defined in: frontend/sdk/src/ticker.ts:9
Host-managed periodic updates bound to one plugin context lifetime.
Properties
tick$
readonlytick$:Observable<TickerTick>
Defined in: frontend/sdk/src/ticker.ts:13
Methods
destroy()
destroy():
void
Defined in: frontend/sdk/src/ticker.ts:14
Returns
void
setInterval()
setInterval(
intervalMs):void
Defined in: frontend/sdk/src/ticker.ts:11
Parameters
intervalMs
number
Returns
void
start()
start(
intervalMs):void
Defined in: frontend/sdk/src/ticker.ts:10
Parameters
intervalMs
number
Returns
void
stop()
stop():
void
Defined in: frontend/sdk/src/ticker.ts:12
Returns
void
TickerTick
Defined in: frontend/sdk/src/ticker.ts:3
Properties
drift
readonlydrift:number
Defined in: frontend/sdk/src/ticker.ts:5
timestamp
readonlytimestamp:number
Defined in: frontend/sdk/src/ticker.ts:4
Translator
Defined in: frontend/sdk/src/translator.ts:1
Properties
direction
readonlydirection:"ltr"
Defined in: frontend/sdk/src/translator.ts:7
Reserved forward-compatibility field; RTL is out of scope and value is always 'ltr'.
locale
readonlylocale:string
Defined in: frontend/sdk/src/translator.ts:5
Methods
formatDate()
formatDate(
value,options?):string
Defined in: frontend/sdk/src/translator.ts:4
Parameters
value
Date
options?
DateTimeFormatOptions
Returns
string
formatNumber()
formatNumber(
value,options?):string
Defined in: frontend/sdk/src/translator.ts:3
Parameters
value
number
options?
NumberFormatOptions
Returns
string
t()
t(
key,values?):string
Defined in: frontend/sdk/src/translator.ts:2
Parameters
key
string
values?
Record<string, unknown>
Returns
string
WidgetPluginContext
Defined in: frontend/sdk/src/context.ts:136
Extends
PluginContextBase
Properties
backend?
optionalbackend?:BackendClient
Defined in: frontend/sdk/src/context.ts:129
Typed backend client. Present only when the plugin declares a backend; ids resolve locally from the daemon's descriptor snapshot. See BackendClient.
Inherited from
PluginContextBase.backend
deviceInfo
deviceInfo:
DeviceInfo
Defined in: frontend/sdk/src/context.ts:110
Inherited from
PluginContextBase.deviceInfo
events?
optionalevents?:PluginEventFacade
Defined in: frontend/sdk/src/context.ts:106
Inherited from
PluginContextBase.events
i18n
i18n:
PluginI18n
Defined in: frontend/sdk/src/context.ts:111
Inherited from
PluginContextBase.i18n
instanceId
instanceId:
string
Defined in: frontend/sdk/src/context.ts:112
Inherited from
PluginContextBase.instanceId
kind
readonlykind:"widget"
Defined in: frontend/sdk/src/context.ts:137
locale
readonlylocale:string
Defined in: frontend/sdk/src/context.ts:118
Current host locale. This getter follows changes while the plugin is mounted.
Inherited from
PluginContextBase.locale
locale$
readonlylocale$:Observable<string>
Defined in: frontend/sdk/src/context.ts:120
Emits the current locale on subscribe and completes when the plugin unmounts.
Inherited from
PluginContextBase.locale$
navigation
readonlynavigation:HostNavigation
Defined in: frontend/sdk/src/context.ts:104
Inherited from
PluginContextBase.navigation
overlay
overlay:
OverlayService
Defined in: frontend/sdk/src/context.ts:131
Framework-agnostic top-layer UI (modal, drawer, popover, custom).
Inherited from
PluginContextBase.overlay
pageRoute?
readonlyoptionalpageRoute?:undefined
Defined in: frontend/sdk/src/context.ts:139
Widgets do not receive page navigation.
palette
readonlypalette:PaletteTokenMap
Defined in: frontend/sdk/src/context.ts:122
Current applied palette, including a device override when present.
Inherited from
PluginContextBase.palette
palette$
readonlypalette$:Observable<PaletteTokenMap>
Defined in: frontend/sdk/src/context.ts:124
Emits the current palette on subscribe and completes when the plugin unmounts.
Inherited from
PluginContextBase.palette$
rciManager
rciManager:
PluginRciManager
Defined in: frontend/sdk/src/context.ts:107
Inherited from
PluginContextBase.rciManager
setTileTitle?
readonlyoptionalsetTileTitle?: (title) =>void
Defined in: frontend/sdk/src/context.ts:141
Set the host tile title.
Parameters
title
string
Returns
void
sharedStorage
sharedStorage:
PluginStorage
Defined in: frontend/sdk/src/context.ts:109
Inherited from
PluginContextBase.sharedStorage
storage
storage:
PluginStorage
Defined in: frontend/sdk/src/context.ts:108
Inherited from
PluginContextBase.storage
telemetry
readonlytelemetry:PluginTelemetry
Defined in: frontend/sdk/src/context.ts:105
Inherited from
PluginContextBase.telemetry
theme
readonlytheme:"light"|"dark"
Defined in: frontend/sdk/src/context.ts:114
Current host theme. This getter follows changes while the plugin is mounted.
Inherited from
PluginContextBase.theme
theme$
readonlytheme$:Observable<"light"|"dark">
Defined in: frontend/sdk/src/context.ts:116
Emits the current theme on subscribe and completes when the plugin unmounts.
Inherited from
PluginContextBase.theme$
Methods
createTicker()
createTicker():
Ticker
Defined in: frontend/sdk/src/context.ts:133
Creates a host-managed ticker destroyed when this plugin context ends.
Returns
Inherited from
PluginContextBase.createTicker
Type Aliases
BackendApprovalStatus
BackendApprovalStatus =
"approved"|"pending"|"denied"
Defined in: frontend/sdk/src/backend-client.ts:23
Typed backend client handed to plugins as context.backend. It resolves HTTP and WebSocket route ids from the daemon's capability snapshot and applies the same approval and enabled checks before issuing a request.
Ids resolve locally from a descriptor snapshot taken from GET /api/mgmt/list, no per-call lookup. Two error layers:
- client-side pre-check from the snapshot - a typo (
BackendUnknownId) throws synchronously; a known-unapproved / disabled binding rejects fast (BackendNotApproved/BackendDisabled); - the daemon is authoritative - its structured error envelope codes
NOT_APPROVED,DISABLED,ROUTE_NOT_FOUND,BACKEND_STARTING,BACKEND_UNAVAILABLE,BACKEND_INCOMPATIBLE,BACKEND_MAINTENANCE,BACKEND_BLOCKED, andBAD_GATEWAYmap onto the same typed errors when state changed after load.
Plugins handle one error family either way. status() is separate: it is a live, passive, bound-plugin query and is not a readiness probe.
BackendBlocker
BackendBlocker =
z.infer<typeofbackendBlockerSchema>
Defined in: frontend/sdk/src/backend-client.ts:88
BackendErrorCode
BackendErrorCode =
"UNKNOWN_ID"|"NOT_APPROVED"|"DISABLED"|"TRANSPORT_MISMATCH"|"BACKEND_STARTING"|"BACKEND_UNAVAILABLE"|"BACKEND_INCOMPATIBLE"|"BACKEND_MAINTENANCE"|"BACKEND_BLOCKED"|"BAD_GATEWAY"|"STATUS_QUERY_FAILED"
Defined in: frontend/sdk/src/backend-client.ts:146
BackendStatus
BackendStatus =
z.infer<typeofbackendStatusSchema>
Defined in: frontend/sdk/src/backend-client.ts:89
BackendStatusState
BackendStatusState =
BackendStatus["state"]
Defined in: frontend/sdk/src/backend-client.ts:90
EventSource
EventSource =
z.infer<typeofeventSourceSchema>
Defined in: frontend/sdk/src/event-schema.ts:221
EventTopic
EventTopic =
MndwEvent["topic"]
Defined in: frontend/sdk/src/event-schema.ts:222
HistoryStatus
HistoryStatus =
"current"|"catching-up"|"historical"|"empty"|"legacy"
Defined in: frontend/sdk/src/telemetry-client.ts:349
HostTarget
HostTarget = {
kind:"dashboard"; } | {kind:"packages"; } | {kind:"settings";tab?:"general"|"diagnostics"|"plugins"|"self-update"; } | {kind:"plugin-page";path?:string;plugin:string; }
Defined in: frontend/sdk/src/context.ts:26
KnownTelemetryUnit
KnownTelemetryUnit =
"percent"|"celsius"
Defined in: frontend/sdk/src/telemetry-client.ts:42
LoadState
LoadState<
T,E> = {status:"idle"; } | {status:"loading"; } | {data:T;status:"success"; } | {data:T;status:"refreshing"; } | {data?:T;error:E;status:"error"; } | {reason:string;status:"unsupported"; }
Defined in: frontend/sdk/src/load-state.ts:1
Type Parameters
T
T
E
E = unknown
MndwEvent
MndwEvent =
z.infer<typeofeventSchema>
Defined in: frontend/sdk/src/event-schema.ts:220
OverlayCloseReason
OverlayCloseReason =
"api"|"action"|"escape"|"outside-click"|"host-navigation"|"plugin-unmount"|"replaced"|"anchor-lost"|"mount-failed"
Defined in: frontend/sdk/src/overlay.ts:28
Only api and action are plugin-assignable via close(). All other reasons are host-assigned (navigation, unmount, replacement, anchor loss, mount failure).
OverlayKind
OverlayKind =
"modal"|"drawer"|"popover"|"custom"
Defined in: frontend/sdk/src/overlay.ts:7
Framework-agnostic overlay SDK. Host owns stacking, focus, dismissal, backdrop, scroll lock, and cleanup; plugins mount their own content into host-provided targets and register teardown. Host never re-parents already-rendered plugin DOM.
OverlayMount
OverlayMount<
Result> = (target,layer,signal) =>void|Promise<void>
Defined in: frontend/sdk/src/overlay.ts:93
Type Parameters
Result
Result = unknown
Parameters
target
HTMLElement
layer
OverlayLayer<Result>
signal
AbortSignal
Returns
void | Promise<void>
OverlayPlacement
OverlayPlacement =
"center"|"top"|"right"|"bottom"|"left"|"top-start"|"top-end"|"bottom-start"|"bottom-end"|"right-start"|"right-end"|"left-start"|"left-end"
Defined in: frontend/sdk/src/overlay.ts:9
PageRouteErrorCode
PageRouteErrorCode =
"INVALID_PATH"|"COMPLETED"|"NAVIGATION_FAILED"
Defined in: frontend/sdk/src/context.ts:24
PaletteTokenMap
PaletteTokenMap =
Record<ThemeName,Record<TokenName,string>>
Defined in: tooling/palette-core/src/metadata.ts:27
PluginContext
PluginContext =
WidgetPluginContext|PagePluginContext
Defined in: frontend/sdk/src/context.ts:153
Compatibility alias for plugins that consume both widget and page contexts.
PluginRciManager
PluginRciManager =
Pick<RciManager,PluginRciManagerMethod>
Defined in: frontend/sdk/src/rci.ts:12
PluginRciManagerMethod
PluginRciManagerMethod = typeof
PLUGIN_RCI_MANAGER_METHODS[number]
Defined in: frontend/sdk/src/rci.ts:10
ProjectedChartColor
ProjectedChartColor =
"accent"|"success"|"warning"|"muted"
Defined in: frontend/sdk/src/telemetry-client.ts:19
ProjectRange
ProjectRange =
"1h"|"3h"|"1d"|"7d"|"30d"
Defined in: frontend/sdk/src/telemetry-client.ts:12
TelemetryClockState
TelemetryClockState =
"unanchored"|"anchored"|"suspect"
Defined in: frontend/sdk/src/telemetry-client.ts:3
TelemetryUnit
TelemetryUnit =
KnownTelemetryUnit|string&object
Defined in: frontend/sdk/src/telemetry-client.ts:43
ThemeName
ThemeName =
"light"|"dark"
Defined in: tooling/palette-core/src/metadata.ts:1
TokenName
TokenName =
"bg"|"surface"|"surfaceRaised"|"border"|"textSubtle"|"textMuted"|"text"|"accent"|"accentHover"|"accentContrast"|"danger"|"dangerBg"|"success"|"successBg"|"warning"|"warningBg"|"info"|"infoBg"|"focusRing"|"surfaceHover"|"controlHover"|"shadowColor"
Defined in: tooling/palette-core/src/metadata.ts:3
Variables
KNOWN_TELEMETRY_UNITS
constKNOWN_TELEMETRY_UNITS: readonlyKnownTelemetryUnit[]
Defined in: frontend/sdk/src/telemetry-client.ts:45
PLUGIN_RCI_MANAGER_METHODS
constPLUGIN_RCI_MANAGER_METHODS: readonly ["execute","queue","initBackgroundProcess","queueBackgroundProcess"]
Defined in: frontend/sdk/src/rci.ts:3
SDK_VERSION
constSDK_VERSION:"0.1.6"='0.1.6'
Defined in: frontend/sdk/src/version.ts:2
The @mndw/sdk package version, pinned to package.json by version.test.ts.
Functions
historyStatus()
historyStatus(
clock):HistoryStatus
Defined in: frontend/sdk/src/telemetry-client.ts:351
Parameters
clock
TelemetryClock | undefined
Returns
isBackendMaintenanceClose()
isBackendMaintenanceClose(
event):boolean
Defined in: frontend/sdk/src/backend-client.ts:138
Returns true for an intentional daemon maintenance close; callers must show an explicit reconnect affordance and never silently recreate the socket.
Parameters
event
Pick<CloseEvent, "code" | "reason">
Returns
boolean
isKnownTelemetryUnit()
isKnownTelemetryUnit(
unit):unit is KnownTelemetryUnit
Defined in: frontend/sdk/src/telemetry-client.ts:47
Parameters
unit
string
Returns
unit is KnownTelemetryUnit
References
MNDW_SCALE
Re-exports MNDW_SCALE
MNDW_TOKENS
Re-exports MNDW_TOKENS
MndwThemeName
Re-exports MndwThemeName