API Reference
    Preparing search index...

    Type Alias ParseFunction

    ParseFunction: {
        <T extends StandardSchemaV1<unknown, unknown>>(
            data: unknown,
            envelope: undefined,
            schema: T,
            safeParse?: false,
        ): InferOutput<T>;
        <T extends StandardSchemaV1<unknown, unknown>>(
            data: unknown,
            envelope: undefined,
            schema: T,
            safeParse: true,
        ): ParsedResult<unknown, InferOutput<T>>;
        <T extends StandardSchemaV1<unknown, unknown>, E extends Envelope>(
            data: unknown,
            envelope: E,
            schema: T,
            safeParse?: false,
        ): E extends DynamoDBArrayEnvelope
            ? DynamoDBStreamEnvelopeResponse<InferOutput<T>>[]
            : E extends ArrayEnvelope ? InferOutput<T>[] : InferOutput<T>;
        <T extends StandardSchemaV1<unknown, unknown>, 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>>;
    }

    The parser function that can parse the data using the provided schema and envelope we use function overloads to provide the correct return type based on the provided envelope

    Type declaration

    Settings

    Member Visibility