planning-center-monorepo v1.0.0
planning-center-monorepo / planning-center-base-ts/src / PaginationHelper
Class: PaginationHelper
Defined in: packages/planning-center-base-ts/src/pagination.ts:43
Constructors
Constructor
new PaginationHelper(
httpClient,getConfig?):PaginationHelper
Defined in: packages/planning-center-base-ts/src/pagination.ts:44
Parameters
httpClient
getConfig?
() => PcoClientConfig
Returns
PaginationHelper
Methods
getAllPages()
getAllPages<
T,TIncluded,TRelResourceMap>(endpoint,params,options):Promise<PaginationResult<T,TIncluded,TRelResourceMap>>
Defined in: packages/planning-center-base-ts/src/pagination.ts:54
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>
Parameters
endpoint
string
params
Record<string, any> = {}
options
PaginationOptions = {}
Returns
Promise<PaginationResult<T, TIncluded, TRelResourceMap>>
getPage()
getPage<
T,TIncluded>(endpoint,page,perPage,params):Promise<Paginated<T,TIncluded>>
Defined in: packages/planning-center-base-ts/src/pagination.ts:198
Type Parameters
T
T extends ResourceObject<string, any, any>
TIncluded
TIncluded extends ResourceObject<string, any, any> = ResourceObject<string, any, any>
Parameters
endpoint
string
page
number = 1
perPage
number = 100
params
Record<string, any> = {}
Returns
Promise<Paginated<T, TIncluded>>
streamPages()
streamPages<
T>(endpoint,params,options):AsyncGenerator<T[],void,unknown>
Defined in: packages/planning-center-base-ts/src/pagination.ts:217
Type Parameters
T
T extends ResourceObject<string, any, any>
Parameters
endpoint
string
params
Record<string, any> = {}
options
PaginationOptions = {}
Returns
AsyncGenerator<T[], void, unknown>
getAllPagesParallel()
getAllPagesParallel<
T,TIncluded>(endpoint,params,options):Promise<PaginationResult<T,TIncluded,Record<string,never>>>
Defined in: packages/planning-center-base-ts/src/pagination.ts:267
Get all pages with parallel processing for better performance
Type Parameters
T
T extends ResourceObject<string, any, any>
TIncluded
TIncluded extends ResourceObject<string, any, any> = ResourceObject<string, any, any>
Parameters
endpoint
string
params
Record<string, any> = {}
options
PaginationOptions & object = {}
Returns
Promise<PaginationResult<T, TIncluded, Record<string, never>>>