getIndex #

Available since 2.11.0

Returns the index specified in the request.

Arguments #

Copied to clipboard!

getIndex (): string

Example #

Copied to clipboard!

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