Skip to content

Interface: OperationApi<Ops>

Defined in: src/testing/FakeInstance.ts:51

Type Parameters

Type Parameter
Ops extends Record<string, OperationDef>

Properties

PropertyTypeDescriptionDefined in
on{ [Operation in string | number | symbol]: (responder: OperationResponder) => void }Override an operation's response. Last call wins.src/testing/FakeInstance.ts:60
once{ [Operation in string | number | symbol]: (responder: OperationResponder) => void }Override an operation's next response only, then fall back.src/testing/FakeInstance.ts:62

Methods

callsTo()

ts
callsTo<Operation>(operation): PayloadOf<Ops[Operation]>[];

Defined in: src/testing/FakeInstance.ts:56

Canonical payloads of the requests an operation received (in order). Only operations with a decoder; use calls() for wire-level access.

Type Parameters

Type Parameter
Operation extends string | number | symbol

Parameters

ParameterType
operationOperation

Returns

PayloadOf<Ops[Operation]>[]


waitForPayload()

ts
waitForPayload<Operation>(
   operation, 
   predicate?, 
options?): Promise<PayloadOf<Ops[Operation]>>;

Defined in: src/testing/FakeInstance.ts:67

Wait until an operation receives a request, then return its canonical payload.

Type Parameters

Type Parameter
Operation extends string | number | symbol

Parameters

ParameterType
operationOperation
predicate?(payload) => boolean
options?{ timeoutMs?: number; }
options.timeoutMs?number

Returns

Promise<PayloadOf<Ops[Operation]>>