Framework v2.x

getArray #

Available since 2.11.0

Gets a parameter from the request arguments and checks that it is an array.

Available since 2.18.1

If the request has been made with the HTTP protocol and the request argument is not an Array but a JSON String the argument will be parsed and returned if it's an array, otherwise an error will be thrown.

Arguments #

Copied to clipboard!
getArray (name: string, def: [] = null): any[]

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

Example #

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