testing

Classes

InboxTestError

Defined in: src/testing/index.ts:36

Extends

• Error

Constructors

Constructor

new InboxTestError(
   code,
   message,
   records?): InboxTestError;

Defined in: src/testing/index.ts:39

Parameters

Parameter	Type	Default value
code	InboxTestErrorCode	undefined
message	string	undefined
records	readonly InboxTestSnapshot[]	[]

Returns

InboxTestError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

code

readonly code: InboxTestErrorCode;

Defined in: src/testing/index.ts:40

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

records

readonly records: readonly InboxTestSnapshot[];

Defined in: src/testing/index.ts:37

stack?

optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: 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()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: 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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

Interfaces

InboxTestOptions

Defined in: src/testing/index.ts:6

Extended by

• InboxWaitOptions

Properties

maxPasses?

optional maxPasses?: number;

Defined in: src/testing/index.ts:12

Maximum state-check passes. Default: 1,000.

pollIntervalMs?

optional pollIntervalMs?: number;

Defined in: src/testing/index.ts:10

Delay between state checks. Default: 10.

signal?

optional signal?: AbortSignal;

Defined in: src/testing/index.ts:13

timeoutMs?

optional timeoutMs?: number;

Defined in: src/testing/index.ts:8

Overall wait budget, including database reads and worker execution. Default: 5,000.

---

InboxTestSnapshot

Defined in: src/testing/index.ts:22

Safe diagnostics; deliberately excludes payloads, scope and handler error text.

Properties

attemptCount

attemptCount: number | null;

Defined in: src/testing/index.ts:25

cycleAttemptCount

cycleAttemptCount: number | null;

Defined in: src/testing/index.ts:26

id

id: string;

Defined in: src/testing/index.ts:23

status

status: InboxStatus | null;

Defined in: src/testing/index.ts:24

---

InboxWaitOptions

Defined in: src/testing/index.ts:16

Extends

• InboxTestOptions

Properties

maxPasses?

optional maxPasses?: number;

Defined in: src/testing/index.ts:12

Maximum state-check passes. Default: 1,000.

Inherited from

InboxTestOptions.maxPasses

pollIntervalMs?

optional pollIntervalMs?: number;

Defined in: src/testing/index.ts:10

Delay between state checks. Default: 10.

Inherited from

InboxTestOptions.pollIntervalMs

signal?

optional signal?: AbortSignal;

Defined in: src/testing/index.ts:13

Inherited from

InboxTestOptions.signal

status?

optional status?: "COMPLETED" | "DEAD";

Defined in: src/testing/index.ts:18

The terminal state to wait for. Default: COMPLETED.

timeoutMs?

optional timeoutMs?: number;

Defined in: src/testing/index.ts:8

Overall wait budget, including database reads and worker execution. Default: 5,000.

Inherited from

InboxTestOptions.timeoutMs

Type Aliases

InboxTestErrorCode

type InboxTestErrorCode =
  | "INVALID_OPTIONS"
  | "TIMEOUT"
  | "ABORTED"
  | "PASS_LIMIT"
  | "UNEXPECTED_TERMINAL_STATE";

Defined in: src/testing/index.ts:29

Functions

drainInbox()

function drainInbox(
   inbox,
   admin,
   ids,
options?): Promise<InboxRecord[]>;

Defined in: src/testing/index.ts:189

Run the real worker until the requested receipts are COMPLETED. IDs select assertions, not claims: runOnce may process other owned receipts. Timeout/cancellation stops waiting and new polls; it cannot cancel an in-flight transaction.

Parameters

Parameter	Type
inbox	Runner
admin	Reader
ids	readonly string[]
options	InboxTestOptions

Returns

Promise<InboxRecord[]>

---

waitForInboxRecord()

function waitForInboxRecord(
   admin,
   id,
options?): Promise<InboxRecord>;

Defined in: src/testing/index.ts:204

Observe an existing worker without starting processing or changing the receipt.

Parameters

Parameter	Type
admin	Reader
id	string
options	InboxWaitOptions

Returns

Promise<InboxRecord>