requireMessage()function

requireMessage(input: PossibleMessage, caller: AnyCaller = requireMessage): string
ParamType
inputPossibleMessage
The value to read a message from (a string, or an object with a message string). required
callerAnyCaller
Function to attribute a thrown error to (defaults to requireMessage). Defaults to requireMessage
Return
string
The message string.
Throws
unknown
RequiredError if no message could be found.

Require a message from an unknown value, or throw RequiredError if it could not be found.

Examples

requireMessage(new Error("Boom")) // "Boom"