planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-base-ts/src / PaginationResult

Interface: PaginationResult<T, TIncluded, TRelResourceMap>

Defined in: packages/planning-center-base-ts/src/pagination.ts:23 

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/src/pagination.ts:28 

totalCount

totalCount: number

Defined in: packages/planning-center-base-ts/src/pagination.ts:34 

pagesFetched

pagesFetched: number

Defined in: packages/planning-center-base-ts/src/pagination.ts:35 

duration

duration: number

Defined in: packages/planning-center-base-ts/src/pagination.ts:36 

meta?

optional meta: Meta

Defined in: packages/planning-center-base-ts/src/pagination.ts:38 

Meta information from the API response (from last page)

links?

optional links: TopLevelLinks

Defined in: packages/planning-center-base-ts/src/pagination.ts:40 

Links from the API response (from last page)