2.5.0Enum of event types.
Type: Symbol
Read a JSON file. Takes a variable number of arguments with will be joined using path.join to a single file path.
(string)
The path.
Promise<Object>:
The parsed event.
Create a handler factory for EventBridge events. Handles EventBridge rule events and redriven events from SQS. See the README for an explanation of how to use the returned handler factory.
(Object)
Overrides passed to createHandler.
Object:
The handler factory.
Create a basic event handler factory. See the README for an explanation of how to use the returned handler factory.
(Object)
| Name | Description |
|---|---|
parameters.parser string
(default identityParser)
|
Event parser. |
parameters.serializer string
(default identitySerializer)
|
Payload serializer. |
parameters.createProcessor string
(default createNullProcessor)
|
Processor factory. |
parameters.createWrapper string
(default createInvokeWrapper)
|
Wrapper factory. |
parameters.createStrategy string
(default createEventStrategy)
|
Strategy factory. |
parameters.registerDependencies string
(default registerEmptyDependencies)
|
Called to register dependencies. |
Object:
The handler factory.
Create a handler factory for invocation events. See the README for an explanation of how to use the returned handler factory.
(Object)
Overrides passed to createHandler.
Object:
The handler factory.
Create a handler factory for SQS events.
(Object)
Overrides passed to createHandler.
Object:
The handler factory.
Create a handler factory for SQS events with JSON body. See the README for an explanation of how to use the returned handler factory.
(Object)
Overrides passed to createHandler.
Object:
The handler factory.
Security HTTP headers.
Type: Object
API Gateway Proxy event parser.
(Object)
The event.
Object:
The parsed event.
Includes searchParams as an instance of URLSearchParams.
API Gateway Proxy JSON event parser.
(Object)
The event.
Object:
The parsed event with the body parsed as JSON.
Includes searchParams as an instance of URLSearchParams.
Parser for EventBridge events. Parses EventBridge rule events and redriven events from SQS.
(Object)
The event.
Array<Object>:
The parsed events.
Identity function.
(Object)
The event.
Object:
The parsed event.
Records parser.
(Object)
The event.
Array<Object>:
The records from the parsed event.
SQS event parser.
(Object)
The event.
Array<Object>:
The messages from the parsed event.
Both attributes and messageAttributes are parsed into plain objects
with proper types.
SQS JSON event parser.
(Object)
The event.
Array<Object>:
The messages from the parsed event with the body parsed as JSON.
Both attributes and messageAttributes are parsed into plain objects
with proper types.
API Gateway Proxy event serializer.
(Object)
The data.
Object:
The serialized data.
API Gateway Proxy JSON event serializer.
(Object)
The data.
Object:
The serialized data with the body serialized to JSON.
Identity function.
(Object)
The data.
Object:
The serialized data.
Create an event strategy. Resolves and calls the processor for the event. Resolves and calls onError on an event error.
(Object)
The Awilix container.
Array<Object>:
The strategy.
Create an HTTP strategy. Resolves and calls the processor for the event. Swallows all errors, wraps them as a Boom object, resolves and calls onError on the wrapped error, and returns a matching status code response.
(Object)
The Awilix container.
Array<Object>:
The strategy.
Create a parallel strategy for an array of events. Resolves and calls the processor for each event element. Resolves and calls onError on each element error.
(Object)
The Awilix container.
function:
The strategy.
Create an invoke wrapper.
(Object)
The parent logger.
(function)
The strategy.
(function)
The parser.
(function)
The serializer.
function:
The wrapper.
Create a record wrapper.
function:
The wrapper.