Class: RequestParameters

vertx-web-api-contract-js/request_parameters~ RequestParameters

new RequestParameters()

Container for request parameters
Source:

Methods

body() → {RequestParameter}

Return request body
Source:
Returns:
Type
RequestParameter

cookieParameter(name) → {RequestParameter}

Get cookie parameter by name
Parameters:
Name Type Description
name string Parameter name
Source:
Returns:
Type
RequestParameter

cookieParametersNames() → {Array.<string>}

Get list of all parameter names inside cookie
Source:
Returns:
Type
Array.<string>

formParameter(name) → {RequestParameter}

Get form parameter by name
Parameters:
Name Type Description
name string Parameter name
Source:
Returns:
Type
RequestParameter

formParametersNames() → {Array.<string>}

Get list of all parameter names inside body form
Source:
Returns:
Type
Array.<string>

headerParameter(name) → {RequestParameter}

Get header parameter by name
Parameters:
Name Type Description
name string Parameter name
Source:
Returns:
Type
RequestParameter

headerParametersNames() → {Array.<string>}

Get list of all parameter names inside header
Source:
Returns:
Type
Array.<string>

pathParameter(name) → {RequestParameter}

Get path parameter by name
Parameters:
Name Type Description
name string Parameter name
Source:
Returns:
Type
RequestParameter

pathParametersNames() → {Array.<string>}

Get list of all parameter names inside path
Source:
Returns:
Type
Array.<string>

queryParameter(name) → {RequestParameter}

Get query parameter by name
Parameters:
Name Type Description
name string Parameter name
Source:
Returns:
Type
RequestParameter

queryParametersNames() → {Array.<string>}

Get list of all parameter names inside query
Source:
Returns:
Type
Array.<string>