planning-center-monorepo / planning-center-check-ins-ts/src / PaginationResult

Interface: PaginationResult<T, TIncluded, TRelResourceMap>

Defined in: packages/planning-center-base-ts/dist/pagination.d.ts:18

Type Parameters

T

T extends ResourceObject<string, any, any>

TIncluded

TIncluded extends ResourceObject<string, any, any> = ResourceObject<string, any, any>

TRelResourceMap

TRelResourceMap extends Record<string, ResourceObject<string, any, any> | ResourceObject<string, any, any>[]> = Record<string, never>

Properties

data

data: FlattenedResource<T["type"], T extends ResourceObject<string, TAttrs, any> ? TAttrs : never, T extends ResourceObject<any, any, TRelMap> ? TRelMap : never, TRelResourceMap>[]

Defined in: packages/planning-center-base-ts/dist/pagination.d.ts:19

totalCount

totalCount: number

Defined in: packages/planning-center-base-ts/dist/pagination.d.ts:20

pagesFetched

pagesFetched: number

Defined in: packages/planning-center-base-ts/dist/pagination.d.ts:21

duration

duration: number

Defined in: packages/planning-center-base-ts/dist/pagination.d.ts:22

meta?

optional meta: Meta

Defined in: packages/planning-center-base-ts/dist/pagination.d.ts:24

Meta information from the API response (from last page)

links?

optional links: TopLevelLinks

Defined in: packages/planning-center-base-ts/dist/pagination.d.ts:26

Links from the API response (from last page)