@aws-lambda-powertools/parser/lib/esm/parser.d.ts

The parser package for the Powertools for AWS Lambda (TypeScript) library.

import type { StandardSchemaV1 } from '@standard-schema/spec';
import type { ArrayEnvelope, DynamoDBArrayEnvelope, DynamoDBStreamEnvelopeResponse, Envelope } from './types/index.js';
import type { InferOutput, ParsedResult } from './types/parser.js';
/**
 * Parse the data using the provided schema and optional envelope.
 *
 * @example
 * ```typescript
 * import { z } from 'zod';
 * import type { SqsEvent, ParsedResult } from '@aws-lambda-powertools/parser/types';
 * import { SqsEnvelope } from '@aws-lambda-powertools/parser/types/envelopes';
 * import { parse } from '@aws-lambda-powertools/parser';
 *
 * const Order = z.object({
 *   orderId: z.string(),
 *   description: z.string(),
 * });
 *
 * const handler = async (event: SqsEvent, context: unknown): Promise<unknown> => {
 *   const parsedEvent = parse(event, SqsEnvelope, Order);
 * }
 * ```
 *
 * @param data - the data to parse
 * @param envelope - optional envelope to use when parsing the data
 * @param schema - the schema to use
 * @param safeParse - whether to throw on error, if `true` it will return a `ParsedResult` with the original event if the parsing fails
 */
declare function parse<T extends StandardSchemaV1>(data: unknown, envelope: undefined, schema: T, safeParse?: false): InferOutput<T>;
declare function parse<T extends StandardSchemaV1>(data: unknown, envelope: undefined, schema: T, safeParse: true): ParsedResult<unknown, InferOutput<T>>;
declare function parse<T extends StandardSchemaV1>(data: unknown, envelope: undefined, schema: T, safeParse: boolean): InferOutput<T> | ParsedResult<unknown, InferOutput<T>>;
declare function parse<T extends StandardSchemaV1, E extends Envelope>(data: unknown, envelope: E, schema: T, safeParse?: false): E extends DynamoDBArrayEnvelope ? DynamoDBStreamEnvelopeResponse<InferOutput<T>>[] : E extends ArrayEnvelope ? InferOutput<T>[] : InferOutput<T>;
declare function parse<T extends StandardSchemaV1, E extends Envelope>(data: unknown, envelope: E, schema: T, safeParse: true): E extends DynamoDBArrayEnvelope ? ParsedResult<unknown, DynamoDBStreamEnvelopeResponse<InferOutput<T>>[]> : E extends ArrayEnvelope ? ParsedResult<unknown, InferOutput<T>[]> : ParsedResult<unknown, InferOutput<T>>;
declare function parse<T extends StandardSchemaV1>(data: unknown, envelope: undefined, schema: T, safeParse?: boolean): InferOutput<T> | ParsedResult<unknown, InferOutput<T>>;
declare function parse<T extends StandardSchemaV1, E extends Envelope>(data: unknown, envelope: E, schema: T, safeParse?: boolean): E extends DynamoDBArrayEnvelope ? DynamoDBStreamEnvelopeResponse<InferOutput<T>>[] | ParsedResult<unknown, DynamoDBStreamEnvelopeResponse<InferOutput<T>>[]> : E extends ArrayEnvelope ? InferOutput<T>[] | ParsedResult<unknown, InferOutput<T>[]> : InferOutput<T> | ParsedResult<unknown, InferOutput<T>>;
export { parse };
//# sourceMappingURL=parser.d.ts.map