Skip to main content

Function: paginatedResponse()

paginatedResponse<T>(itemSchema, name): ZodObject<Record<string, ZodOptional<ZodString> | ZodBoolean | ZodOptional<ZodNumber> | ZodArray<T>>>

Defined in: src/api/schemas/common.ts:134

Creates a paginated response schema.

Type Parameters

T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Item schema type

Parameters

itemSchema

T

Schema for list items

name

string = 'data'

Name for the items array field

Returns

ZodObject<Record<string, ZodOptional<ZodString> | ZodBoolean | ZodOptional<ZodNumber> | ZodArray<T>>>

Paginated response schema

Example

const preprintListSchema = paginatedResponse(preprintSummarySchema, 'preprints');