assertRequestHeadPayload()function

assertRequestHeadPayload(payload: unknown, method: RequestHeadMethod, caller: AnyCaller = assertRequestHeadPayload): asserts payload is Nullish<Data>

Param	Type
`payload`	`unknown`	The payload to assert. required
`method`	`RequestHeadMethod`	The HTTP method the payload is for (used in the error message). required
`caller`	`AnyCaller`	Function to attribute a thrown error to (defaults to `assertRequestHeadPayload`). Defaults to `assertRequestHeadPayload`

Return
`asserts payload is Nullish<Data>`

Throws
`RequiredError`	If `payload` is not a data object, `null`, or `undefined`.

Assert that the payload for a HEAD or GET method is a data object, null, or undefined.

Examples

assertRequestHeadPayload({ q: "abc" }, "GET"); // passes