Documentation

Documentation / @zerotal/client / index / RouteShape

Interface: RouteShape

Defined in: client/src/types.ts:36

Shape of a single route entry in the ApiRouteMap.

All fields are optional — omit any that don't apply to a given route.

Properties

params?

optional params?: Record<string, string | number>

Defined in: client/src/types.ts:38

URL path parameters, e.g. { id: string | number }

query?

optional query?: Record<string, string | number | boolean | undefined>

Defined in: client/src/types.ts:40

Query-string parameters

body?

optional body?: Record<string, unknown>

Defined in: client/src/types.ts:42

Request body for POST/PUT/PATCH

response?

optional response?: unknown

Defined in: client/src/types.ts:44

The JSON response body type