Interface RestRequestContext<T, K>

What a request is for, handed to every call-time hook.

Carrying the operation and its subject is what lets one hook serve all four

an Idempotency-Key on create, an If-Match built from the id on update, a fresh token on everything.

interface RestRequestContext<T, K extends keyof T> {
    draft?: Partial<T>;
    id?: T[K];
    operation: RestOperation;
    query?: CrudQuery<T>;
}

Type Parameters

T
K extends keyof T

Index

Properties

draft? id? operation query?

Properties

`Optional`draft

draft?: Partial<T>

Present for create and update.

`Optional`id

id?: T[K]

Present for update and remove.

operation

operation: RestOperation

`Optional`query

query?: CrudQuery<T>

Present for list.