Skip to main content

Interface: RequestContract<B, D>

Defined in: packages/contracts/src/registry.ts:76

A request-and-reply contract: one handler, Reply<data> back.

Type Parameters​

B​

B extends TSchema = TSchema

D​

D extends TSchema = TSchema

Properties​

body​

readonly body: B

Defined in: packages/contracts/src/registry.ts:85

Schema of the request body.

data​

readonly data: D

Defined in: packages/contracts/src/registry.ts:87

Schema of the success payload inside Reply.

kind​

readonly kind: "request"

Defined in: packages/contracts/src/registry.ts:81

Tells a request contract from an event one; it matches the subject's prefix.

mutation​

readonly mutation: boolean

Defined in: packages/contracts/src/registry.ts:83

A mutation requires idempotencyKey in its envelope.