getNumber #

Available since 2.16.9

Gets a parameter from the request arguments and checks that it is a number. We also support lodash syntax. (relations.lebron[0])

Arguments #

Copied to clipboard!

getNumber (name: string, def: number = null): number

Name	Type	Description
name	string	Parameter name
def	number	Default value to return if the parameter is not set

Example #

Copied to clipboard!

const age = request.getNumber('age');
// equivalent
const age = request.input.args.age;
//+ checks to make sure that "age" is of the right type
// and throw standard API error when it's not the case