getRefresh #
Available since 2.11.0
Gets the refresh value.
Arguments #
getRefresh (defaultValue: string = 'false'): string
Name | Type | Description |
---|---|---|
defaultValue | string | Default value to return if the parameter is not set |
Example #
const refresh = request.getRefresh();
// equivalent
const refresh = request.input.args.refresh;
//+ checks to make sure that "refresh" is of the right type
// and throw standard API error when it's not the case
Edit this page on Github (opens new window)