API Reference
    Preparing search index...
    • A Middy.js middleware to parse incoming events using a specified schema and optional envelope.

      Type Parameters

      • TSchema extends StandardSchemaV1<unknown, unknown>
      • TEnvelope extends Envelope
      • TSafeParse extends boolean = false

      Parameters

      Returns MiddlewareObj<ParserOutput<TSchema, TEnvelope, TSafeParse>>

      import { parser } from '@aws-lambda-powertools/parser/middleware';
      import middy from '@middy/core';
      import { SqsEnvelope } from '@aws-lambda-powertools/parser/envelopes/sqs';

      const orderSchema = z.object({
      id: z.number(),
      description: z.string(),
      quantity: z.number(),
      });

      type Order = z.infer<typeof orderSchema>;

      export const handler = middy()
      .use(parser({ schema: orderSchema, envelope: SqsEnvelope }))
      .handler(async (event) => {
      // ^ event is inferred as Order[]
      })