@aws-lambda-powertools/kafka/lib/cjs/consumer.d.ts

Utility to easily handle message deserialization and parsing of Kafka events in AWS Lambda functions

import type { AsyncHandler } from '@aws-lambda-powertools/commons/types';
import type { Context, Handler } from 'aws-lambda';
import type { ConsumerRecords, MSKEvent, SchemaConfig } from './types/types.js';
/**
 * Wrap a handler function to automatically deserialize and validate Kafka records from an MSK event.
 *
 * The returned function will:
 * - Deserialize the key and value of each record using the provided schema config.
 * - Validate the deserialized key and value using Zod schemas if provided.
 * - Replace the `records` property in the event with an array of deserialized and validated records.
 * - Call the original handler with the modified event and original context/arguments.
 *
 * @example
 * ```ts
 * import { kafkaConsumer } from '@aws-lambda-powertools/kafka';
 * import { z } from 'zod';
 *
 * const keySchema = z.string();
 * const valueSchema = z.object({
 *   id: z.number(),
 * });
 *
 * export const handler = kafkaConsumer<z.infer<keySchema>, z.infer<valueSchema>>(async (event, context) => {
 *   // event.records is now an array of deserialized and validated records
 *   for (const record of event.records) {
 *     console.log(record.key, record.value);
 *   }
 * }, {
 *   key: { type: 'json', parserSchema: keySchema },
 *   value: { type: 'json', parserSchema: valueSchema },
 * });
 * ```
 *
 * @typeParam K - Optional type of the deserialized key - defaults to `unknown`.
 * @typeParam V - Optional type of the deserialized value - defaults to `unknown`.
 *
 * @param handler - The original handler function to wrap. It should accept the deserialized event as its first argument.
 * @param config - The schema configuration for deserializing and validating record keys and values.
 */
declare const kafkaConsumer: <K, V>(handler: AsyncHandler<Handler<ConsumerRecords<K, V>>>, config?: SchemaConfig) => ((event: MSKEvent, context: Context) => Promise<unknown>);
export { kafkaConsumer };
//# sourceMappingURL=consumer.d.ts.map