← Back to scenarios
ScenarioCatalog DB

Pagination iterator

Walk through paginated data without revealing how pages are stored or retrieved.

Problem

A client must consume items across multiple data pages without coupling its traversal logic to the underlying pagination, storage, or retrieval implementation.

Related patterns

Iterator

View pattern →

Implementations

Iterator

TypeScriptApplication

Iterator in TypeScript

Exposes sequential traversal of a paginated result collection while keeping the collection’s storage details private.

TypeScript
type SearchResult = {
  id: string;
  title: string;
};

class SearchResults implements Iterable<SearchResult> {
  constructor(private readonly results: SearchResult[]) {}

  *[Symbol.iterator](): Iterator<SearchResult> {
    for (const result of this.results) {
      yield result;
    }
  }
}

const results = new SearchResults([
  { id: "result-1", title: "Architecture overview" },
  { id: "result-2", title: "Deployment guide" },
  { id: "result-3", title: "Incident playbook" },
]);

for (const result of results) {
  console.log(`${result.id}: ${result.title}`);
}

Associated technologies