Esri/arcgis-rest-js

Improve documentation for nextPage() fuctions

Open

#1,206 opened on Mar 18, 2025

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)TypeScript (126 forks)auto 404
good first issue

Repository metrics

Stars
 (389 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

We should update the docs for the various method that support nextPage() function. This means:

We should also document the pattern to paginate thorough resuts to get all results which generally looks like this:

function async getAllResults (response) {
 let allItems = lastResponse.results;

  // Keep getting the next page until there are no more pages.
  while (lastResponse.nextPage) {
    lastResponse = await lastResponse.nextPage();
    allItems = allItems.concat(lastResponse.results);
  }

  return allItems;
}

const allResults = await searchItems(options).then(getAllResults)

Link to page

No response

Contributor guide

Research direction
Explore the existing documentation for the mentioned methods (searchItems, searchGroups, searchUsers, findPlacesNearPoint, findPlacesNearExtent, queryFeatures). Identify where nextPage() is already documented and where it's missing. Look at how other pagination examples are styled in the docs. Then update the docs accordingly and add a generic pagination example.
Tech stack
typescriptjavascript
Domain
apideveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85