Function PaginatedResponse

PaginatedResponse<
    T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
>(
    dataSchema: T,
): ZodObject<
    {
        data: ZodArray<T>;
        pagination: ZodObject<
            {
                limit: ZodNumber;
                offset: ZodNumber;
                sort: ZodOptional<
                    ZodRecord<
                        ZodString,
                        ZodUnion<readonly [ZodLiteral<1>, ZodLiteral<-1>]>,
                    >,
                >;
                total: ZodNumber;
            },
            $strip,
        >;
    },
    $strip,
>
A generic factory for creating a paginated response schema.
Type Parameters
- T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
Parameters
- dataSchema: T
  The Zod schema for the items in the data array.
Returns ZodObject<
    {
        data: ZodArray<T>;
        pagination: ZodObject<
            {
                limit: ZodNumber;
                offset: ZodNumber;
                sort: ZodOptional<
                    ZodRecord<
                        ZodString,
                        ZodUnion<readonly [ZodLiteral<1>, ZodLiteral<-1>]>,
                    >,
                >;
                total: ZodNumber;
            },
            $strip,
        >;
    },
    $strip,
>
- Defined in src/dto/common.ts:52