Class: RouterRequest

Constructor

new RouterRequest(cfReqObj)

Parameters:

Name	Type	Description
`cfReqObj`	CloudFrontRequest	CloudFront request object.

Source: router/Request.js, line 20
See: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-event-structure.html#example-origin-request

Methods

body() → {String}

Return the base64-encoded body data.

Source: router/Request.js, line 156

Returns:

Type:: String

clientIp() → {String}

Return the HTTP client IP (remote address).

Source: router/Request.js, line 147

Returns:

Type:: String

data() → {CloudFrontRequest}

Return CloudFront request object.

Source: router/Request.js, line 38

Returns:

Type:: CloudFrontRequest

getHeaders() → {CloudFrontFunctionsHeaders}

Return the headers of the request.

Source: router/Request.js, line 165

Returns:

Type:: CloudFrontFunctionsHeaders

Return value for given HTTP header name.

Parameters:

Name	Type	Description
`name`	String	HTTP header name.

Source: router/Request.js, line 54

Returns:

Type:: String | undefined

Example

const value = req.header('Content-Type');
// text/html

is(mimeType) → {Boolean}

Check Accept matches the given value.

Parameters:

Name	Type	Description
`mimeType`	String	MIME type value.

Source: router/Request.js, line 78

Returns:

Type:: Boolean

Example

const value = req.is('text/html');
// true

method() → {String}

Return the HTTP method of the request.

Source: router/Request.js, line 120

Returns:

Type:: String

param(name) → {String|Object|undefined}

Return the HTTP request parameters or name/value.

Parameters:

Name	Type	Description
`name`	String	Parameter name (optional).

Source: router/Request.js, line 97

Returns:

Type:: String | Object | undefined

Example

const params = req.param();
// {name: 'value'}

const value = req.param('name');
// value

plugin(name, value) → {*|undefined}

Set/Get value passed down the application stack.

Parameters:

Name	Type	Description
`name`	String	Plugin name.
`value`	*	Plugin value.

Source: router/Request.js, line 188

Returns:

Type:: * | undefined

Example

req.plugin('name', 'value');

  ..

const value = req.plugin('name');
// value

queryString() → {String}

Return the serialized query parameters.

Source: router/Request.js, line 129

Returns:

Type:: String

uri() → {String}

Return the relative path of the requested object.

Source: router/Request.js, line 138

Returns:

Type:: String

(static) isJson(str) → {Boolean}

Check valid JSON string format.

Parameters:

Name	Type	Description
`str`	String	JSON string.

Source: router/Request.js, line 256

Returns:

Type:: Boolean

(static) isParams(str) → {Boolean}

Check valid HTTP request parameters.

Parameters:

Name	Type	Description
`str`	String	Parameter name/value pairs.

Source: router/Request.js, line 242

Returns:

Type:: Boolean

(static) parseBody(str) → {Object|undefined}

Convert base64-encoded request body to object.

Parameters:

Name	Type	Description
`str`	String	base64 string.

Source: router/Request.js, line 208

Returns:

Type:: Object | undefined

(static) parseParams(str) → {Object}

Convert serialized query string to object.

Parameters:

Name	Type	Description
`str`	String	Parameter name/value pairs.

Source: router/Request.js, line 230

Returns:

Type:: Object

Constructor

new RouterRequest(cfReqObj)

Methods

body() → {String}

clientIp() → {String}

data() → {CloudFrontRequest}

getHeaders() → {CloudFrontFunctionsHeaders}

header(name) → {String|undefined}

is(mimeType) → {Boolean}

method() → {String}

param(name) → {String|Object|undefined}

plugin(name, value) → {*|undefined}

queryString() → {String}

uri() → {String}

(static) isJson(str) → {Boolean}

(static) isParams(str) → {Boolean}

(static) parseBody(str) → {Object|undefined}

(static) parseParams(str) → {Object}