@kody/gitlab

src/paginate.ts

16 lines · 595 B · TypeScript
import type { GitlabPaginateOptions } from './types.ts'
export { paginate } from './core.ts'
import { paginate } from './core.ts'

/**
 * Follow GitLab REST Link / x-next-page pagination for array endpoints.
 *
 * @returns Combined `items` from up to `maxPages` pages.
 * @example
 * import gitlabPaginate from 'kody:@kody/gitlab/paginate'
 * const result = await gitlabPaginate({ path: '/projects', query: { membership: true }, maxPages: 2 })
 * // => { items: [...], pages: 2 }
 */
export default async function gitlabPaginate(params: GitlabPaginateOptions) {
	return await paginate(params)
}