Skip to main content

Function: getRequestPayload()

function getRequestPayload(request): Promise<RequestPayloadHandle>

Parses the Robo request body once and exposes a reusable payload helper.

Parameters

ParameterTypeDescription
requestRoboRequestIncoming Robo request whose body should be cached and inspected.

Returns

Promise<RequestPayloadHandle>

A payload handle that exposes get, replace, and assign helpers.

Example

const payload = await getRequestPayload(request)
const { email } = payload.get<{ email: string }>()