Class default<InputType, PathParamsType, QueryParamsType>

Represents a request object with generic types for input, query parameters, and path parameters. Request

Type Parameters

InputType
The type of the input data for the request.
PathParamsType
The type of the path parameters for the request.
QueryParamsType
The type of the query parameters for the request.

Index

Constructors

Methods

containsPathParam containsQueryParam getAuthorizationHeader getBody getContextParam getHeader getMethod getOriginIP getPath getPathParam getPathParams getQueryParam getQueryParams getRequestID setFixedPathParams

Constructors

constructor

new default<InputType, PathParamsType, QueryParamsType>(
    requestEvent: APIGatewayProxyEvent,
    context: Context,
    logger: default,
): default<InputType, PathParamsType, QueryParamsType>
Constructs a new instance of the class.
Type Parameters
- InputType
- PathParamsType
- QueryParamsType
Parameters
- requestEvent: APIGatewayProxyEvent
  The API Gateway event object.
- context: Context
  The context object.
- logger: default
  The logger object.
Returns default<InputType, PathParamsType, QueryParamsType>
None
- Defined in src/API/Request.ts:31

Methods

containsPathParam

containsPathParam(paramName: keyof PathParamsType): boolean
Checks if the given parameter name exists in the PathParamsType object.
Parameters
- paramName: keyof PathParamsType
  The name of the parameter to check.
Returns boolean
- True if the parameter exists, false otherwise.
- Defined in src/API/Request.ts:83

containsQueryParam

containsQueryParam(paramName: keyof QueryParamsType): boolean
Checks if the specified query parameter exists and has a valid value.
Parameters
- paramName: keyof QueryParamsType
  The name of the query parameter to check.
Returns boolean
- True if the query parameter exists and has a valid value, false otherwise.
- Defined in src/API/Request.ts:43

getAuthorizationHeader

getAuthorizationHeader(): null | string
Retrieves the value of the 'Authorization' header from the request.

Returns null | string
The value of the 'Authorization' header, or null if it is not present.
- Defined in src/API/Request.ts:162

getBody

getBody(raw?: boolean): InputType
Retrieves the body of the request event and parses it if it is a string.
Parameters
- Optionalraw: boolean
Returns InputType
The parsed body of the request event.
- Defined in src/API/Request.ts:101

getContextParam

getContextParam(cxtParam: string): any
Retrieves the value of a context parameter from the request context object.
Parameters
- cxtParam: string
  The name of the context parameter to retrieve.
Returns any
The value of the context parameter, or null if it does not exist.
- Defined in src/API/Request.ts:74

getHeader

getHeader(headerName: string): null | string
Retrieves the value of the specified header from the request event headers.
Parameters
- headerName: string
  The name of the header to retrieve.
Returns null | string
- The value of the header, or null if the header is not found.
- Defined in src/API/Request.ts:65

getMethod

getMethod(): HttpMethod
Retrieves the HTTP method of the current request.

Returns HttpMethod
The HTTP method of the request.
- Defined in src/API/Request.ts:129

getOriginIP

getOriginIP(): string
Retrieves the origin IP address of the request.

Returns string
The origin IP address. If the IP address is not available, it returns 'unknown'.
- Defined in src/API/Request.ts:179

getPath

getPath(): string
Retrieves the path from the request event.

Returns string
The path of the request event.
- Defined in src/API/Request.ts:121

getPathParam

getPathParam(paramName: keyof PathParamsType): string
Retrieves the value of a specific path parameter from the URL.
Parameters
- paramName: keyof PathParamsType
  The name of the path parameter to retrieve.
Returns string
The value of the path parameter, or null if it does not exist.
- Defined in src/API/Request.ts:93

getPathParams

getPathParams(): PathParamsType
Retrieves the path parameters from the request event.

Returns PathParamsType
- The path parameters object, or null if not found.
- Defined in src/API/Request.ts:144

getQueryParam

getQueryParam(paramName: keyof QueryParamsType): string
Retrieves the value of a query parameter from the URL.
Parameters
- paramName: keyof QueryParamsType
  The name of the query parameter to retrieve.
Returns string
The value of the query parameter, or null if it does not exist.
- Defined in src/API/Request.ts:53

getQueryParams

getQueryParams(): QueryParamsType
Retrieves the query parameters from the request event.

Returns QueryParamsType
- The query parameters object, or null if not found.
- Defined in src/API/Request.ts:153

getRequestID

getRequestID(): string
Retrieves the request ID associated with the current execution context.

Returns string
The request ID.
- Defined in src/API/Request.ts:170

setFixedPathParams

setFixedPathParams(keys: any[], result: any[]): void
Sets the fixed path parameters in the request event object.
Parameters
- keys: any[]
  An array of keys representing the path parameter names.
- result: any[]
  An array of values representing the path parameter values.
Returns void
None
- Defined in src/API/Request.ts:191

Class default<InputType, PathParamsType, QueryParamsType>

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns default<InputType, PathParamsType, QueryParamsType>

Methods

containsPathParam

Parameters

Returns boolean

containsQueryParam

Parameters

Returns boolean

getAuthorizationHeader

Returns null | string

getBody

Parameters

Returns InputType

getContextParam

Parameters

Returns any

getHeader

Parameters

Returns null | string

getMethod

Returns HttpMethod

getOriginIP

Returns string

getPath

Returns string

getPathParam

Parameters

Returns string

getPathParams

Returns PathParamsType

getQueryParam

Parameters

Returns string

getQueryParams

Returns QueryParamsType

getRequestID

Returns string

setFixedPathParams

Parameters

Returns void

Settings

On This Page