Loop a cursor API into one array

Task

An endpoint returns one page at a time behind a cursor. You want every item in a single array — without writing the while loop, the cursor bookkeeping, and the concat by hand.

Example

One way: declare how to find the next page and which array to collect, and await once.

import { stitch } from 'stitchapi';

const allUsers = stitch({
    baseUrl: 'https://api.example.com',
    path: '/users',
    paginate: {
        next: (prevBody) => {
            const cursor = (prevBody as { nextCursor?: string }).nextCursor;
            return cursor ? { query: { cursor } } : undefined;
        },
        items: (value) => (value as { results: unknown[] }).results,
        max: 20,
    },
});

// One await follows every page and returns the aggregated items.
const users = (await allUsers()) as unknown[];

How it works

next(prevBody) reads the cursor off the previous page's raw body and returns the input for the next page, merged over the original call — set only what changes. Return undefined to stop. items selects the array to aggregate from each page (after unwrap). max caps the page count as a safety net (default 50). Auth, retry, and throttle apply per page, not once for the whole run. Without an output schema the aggregated result is typed unknown[], hence the cast — add a schema to type the rows.

See also