Types overview
Added in v1.0.0
Table of contents
model
EffectHandler (type alias)
Effectful AWS Lambda handler type.
Signature
export type EffectHandler<T, R, E = never, A = void> = (event: T, context: Context) => Effect.Effect<A, E, R>
Added in v1.0.0
EffectHandlerWithLayer (type alias)
Combined object of an EffectHandler and a global layer.
Signature
export type EffectHandlerWithLayer<T, R, E1 = never, E2 = never, A = void> = {
readonly handler: EffectHandler<T, R, E1, A>
readonly layer: Layer.Layer<R, E2>
readonly memoMap?: Layer.MemoMap
}
Added in v1.0.0
Handler (type alias)
AWS Lambda native handler type.
Signature
export type Handler<TEvent = unknown, TResult = any> = (event: TEvent, context: Context) => Promise<TResult>
Added in v1.0.0
StreamHandler (type alias)
Effectful streamed AWS Lambda handler type.
Signature
export type StreamHandler<T, R, E = never, A = string | Uint8Array> = (
event: T,
context: Context
) => Stream.Stream<A, E, R>
Added in v1.5.0
StreamHandlerWithLayer (type alias)
Combined object of an StreamHandler and a global layer.
Signature
export type StreamHandlerWithLayer<T, R, E1 = never, E2 = never, A = string | Uint8Array> = {
readonly handler: StreamHandler<T, R, E1, A>
readonly layer: Layer.Layer<R, E2>
readonly memoMap?: Layer.MemoMap
}
Added in v1.5.0
StreamifyHandler (type alias)
AWS Lambda native streamify handler type.
Signature
export type StreamifyHandler<TEvent = unknown> = (
event: TEvent,
responseStream: awslambda.HttpResponseStream,
context: Context
) => Promise<void>
Added in v1.5.0
utils
ALBEvent
Signature
export declare const ALBEvent: any
Added in v1.4.0
ALBResult
Signature
export declare const ALBResult: any
Added in v1.4.0
APIGatewayProxyEvent
Signature
export declare const APIGatewayProxyEvent: any
Added in v1.4.0
APIGatewayProxyEventV2
Signature
export declare const APIGatewayProxyEventV2: any
Added in v1.4.0
APIGatewayProxyResult
Signature
export declare const APIGatewayProxyResult: any
Added in v1.4.0
APIGatewayProxyResultV2
Signature
export declare const APIGatewayProxyResultV2: any
Added in v1.4.0
CloudFrontRequestEvent
Signature
export declare const CloudFrontRequestEvent: any
Added in v1.4.0
DynamoDBStreamEvent
Signature
export declare const DynamoDBStreamEvent: any
Added in v1.4.0
EventBridgeEvent
Signature
export declare const EventBridgeEvent: any
Added in v1.4.0
KinesisStreamEvent
Signature
export declare const KinesisStreamEvent: any
Added in v1.4.0
LambdaContext
Signature
export declare const LambdaContext: any
Added in v1.4.0
S3Event
Signature
export declare const S3Event: any
Added in v1.4.0
SNSEvent
Signature
export declare const SNSEvent: any
Added in v1.4.0
SQSEvent
Signature
export declare const SQSEvent: any
Added in v1.4.0
SelfManagedKafkaEvent
Signature
export declare const SelfManagedKafkaEvent: any
Added in v1.4.0