Class DynamoDBStreamEnvelope

DynamoDB Stream Envelope to extract data within NewImage/OldImage

Note: Values are the parsed models. Images' values can also be None, and length of the list is the record's amount in the original event.

Hierarchy

Envelope
- DynamoDBStreamEnvelope

Index

Constructors

Methods

parse safeParse

Constructors

constructor

new DynamoDBStreamEnvelope(): DynamoDBStreamEnvelope
Returns DynamoDBStreamEnvelope
Inherited from Envelope.constructor

Methods

`Static`parse

parse<T>(data, schema): DynamoDBStreamEnvelopeResponse<TypeOf<T>>[]
Internal
Abstract function to parse the content of the envelope using provided schema. Both inputs are provided as unknown by the user. We expect the data to be either string that can be parsed to json or object.
Type Parameters
- T extends ZodType<any, ZodTypeDef, any>
Parameters
- data: unknown
  data to parse
- schema: T
  schema
Returns DynamoDBStreamEnvelopeResponse<TypeOf<T>>[]
Overrides Envelope.parse
- Defined in packages/parser/src/envelopes/dynamodb.ts:15

`Static`safeParse

safeParse<T>(data, schema): ParsedResult
Abstract function to safely parse the content of the envelope using provided schema. safeParse is used to avoid throwing errors, thus we catuch all errors and wrap them in the result.
Type Parameters
- T extends ZodType<any, ZodTypeDef, any>
Parameters
- data: unknown
- schema: T
Returns ParsedResult
Overrides Envelope.safeParse
- Defined in packages/parser/src/envelopes/dynamodb.ts:29