Improve documentation for nextPage() fuctions

Métriques du dépôt

Stars

389 étoiles (389 étoiles)

Métriques de merge PR

Métriques PR en attente (Métriques PR en attente)

Description

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)

Guide contributeur

Direction de recherche

Explorez la documentation existante pour les méthodes mentionnées (searchItems, searchGroups, searchUsers, findPlacesNearPoint, findPlacesNearExtent, queryFeatures). Identifiez où nextPage() est déjà documenté et où il manque. Regardez comment d'autres exemples de pagination sont stylisés dans la documentation. Mettez à jour la documentation en conséquence et ajoutez un exemple de pagination générique.

Stack technique

typescriptjavascript

Domaine

apideveloper experience

Type d'issue

Documentation

DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.

1

Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.

1-3 heures

Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.

Active

ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.

Claire

Prérequis

Git

Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.

85