sessions / Exports / StateTransitionError
Class: StateTransitionError
State transition error class
Hierarchy
↳
StateTransitionError
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new StateTransitionError(currentState, targetState, action): StateTransitionError
Parameters
| Name | Type |
|---|---|
currentState | SessionState |
targetState | SessionState |
action | string |
Returns
Overrides
SessionOperationError.constructor
Defined in
packages/sessions/src/constants/error-messages.ts:96
Properties
stackTraceLimit
▪ Static stackTraceLimit: number
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
SessionOperationError.stackTraceLimit
Defined in
node_modules/.pnpm/@types+node@20.17.46/node_modules/@types/node/globals.d.ts:148
cause
• Optional cause: unknown
Inherited from
Defined in
node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
name
• name: string
Inherited from
Defined in
node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1076
message
• message: string
Inherited from
Defined in
node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1077
stack
• Optional stack: string
Inherited from
Defined in
node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1078
code
• Readonly code: SessionErrorKey
Inherited from
Defined in
packages/sessions/src/constants/error-messages.ts:76
context
• Readonly context: Record<string, any>
Inherited from
Defined in
packages/sessions/src/constants/error-messages.ts:77
currentState
• Readonly currentState: SessionState
Defined in
packages/sessions/src/constants/error-messages.ts:92
targetState
• Readonly targetState: SessionState
Defined in
packages/sessions/src/constants/error-messages.ts:93
action
• Readonly action: string
Defined in
packages/sessions/src/constants/error-messages.ts:94
Methods
captureStackTrace
▸ captureStackTrace(targetObject, constructorOpt?): void
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
| Name | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
SessionOperationError.captureStackTrace
Defined in
node_modules/.pnpm/@types+node@20.17.46/node_modules/@types/node/globals.d.ts:132
prepareStackTrace
▸ prepareStackTrace(err, stackTraces): any
Parameters
| Name | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
SessionOperationError.prepareStackTrace
Defined in
node_modules/.pnpm/@types+node@20.17.46/node_modules/@types/node/globals.d.ts:136