limitry.client.collect_all¶

async limitry.client.collect_all(fetch_page, initial_cursor=None)[source]¶

Collect all items from paginated endpoint into a list.

Parameters:

fetch_page (Callable[[Optional[str]], Awaitable[PaginatedResponse[TypeVar(T)]]]) – Async function that fetches a page given an optional cursor
initial_cursor (Optional[str]) – Optional initial cursor to start from

Return type:

list[TypeVar(T)]

Returns:

List of all items from all pages

Example:

async def fetch_events(cursor: Optional[str] = None):
    response = await client.request("GET", "/events", params={"cursor": cursor})
    return PaginatedResponse(
        data=response["data"],
        next_cursor=response.get("nextCursor"),
        has_more=response.get("hasMore", False),
    )

all_events = await collect_all(fetch_events)