Class WithPagination<TPage, TResultItem>

Type Parameters

TPage extends Paginated<TResultItem>
TResultItem

Index

Constructors

Methods

getPage iteratePages iterateResults

Constructors

constructor

new WithPagination<TPage extends Paginated<TResultItem>, TResultItem>(
    createUrl: (options: PaginationOptions) => URL,
    fetch: (url: URL) => Promise<TPage>,
    pagelen?: number,
): WithPagination<TPage, TResultItem>
Type Parameters
- TPage extends Paginated<TResultItem>
- TResultItem
Parameters
- createUrl: (options: PaginationOptions) => URL
- fetch: (url: URL) => Promise<TPage>
- Optionalpagelen: number
Returns WithPagination<TPage, TResultItem>
- Defined in plugins/bitbucket-cloud-common/src/pagination.ts:34

Methods

getPage

getPage(options?: PaginationOptions): Promise<TPage>
Parameters
- Optionaloptions: PaginationOptions
Returns Promise<TPage>
- Defined in plugins/bitbucket-cloud-common/src/pagination.ts:44

iteratePages

iteratePages(options?: PaginationOptions): AsyncGenerator<TPage, void>
Parameters
- Optionaloptions: PaginationOptions
Returns AsyncGenerator<TPage, void>
- Defined in plugins/bitbucket-cloud-common/src/pagination.ts:50

iterateResults

iterateResults(
options?: PaginationOptions,
): AsyncGenerator<Awaited<TResultItem>, void, unknown>
Parameters
- Optionaloptions: PaginationOptions
Returns AsyncGenerator<Awaited<TResultItem>, void, unknown>
- Defined in plugins/bitbucket-cloud-common/src/pagination.ts:63