getString #
Available since 2.16.9
Gets a parameter from the request arguments and checks that it is a string. We also support lodash syntax. (relations.lebron[0])
Arguments #
getString (name: string, def: string = null): string| Name | Type | Description |
|---|---|---|
name | string | Parameter name |
def | string | Default value to return if the parameter is not set |
Example #
const name = request.getString('name');
// equivalent
const name = request.input.args.name;
//+ checks to make sure that "name" is of the right type
// and throw standard API error when it's not the caseEdit this page on Github(opens new window)