paginate-generator

paginate-generator - An async generator facade for paginated APIs

Quick Start

After yarn add paginate-generator:

import { paginate, all } from 'paginate-generator';

// paginatedApi will be called until it either returns no next token,
// or max items have been retrieved (if defined).
async function getIt(max : number) {
  // all neatly gathers the pages into one array, but it may be more
  // efficient to directly use "for await" on the paginate(...) call.
  return all(paginate(async (token?: number) => {
    // token will be undefined on first page (unless you pass one as the second param)
    const apiReturn = await paginatedApi(token || 0);
    return {
      // should be undefined when no more pages to request
      next: apiReturn.nextToken,
      page: apiReturn.items,
    };
  }, undefined, max));
}

License

Read the LICENSE for details.
The entire NOTICE file serves as the NOTICE that must be included under Section 4d of the License.

# paginate-generator

This product contains software originally developed by Holvonix LLC.
Original Repository: https://github.com/holvonix-open/paginate-generator

Copyright (c) 2019 Holvonix LLC. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this software except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependencies may have their own licenses.

Changelog

1.2.7 (2019-11-19)

🐛 Bug Fixes

• deps: [security] bump https-proxy-agent from 2.2.2 to 2.2.4 (#57) (560d6c1)

🧦 Miscellaneous

• deps-dev: bump @holvonix-open/release-config-js (#31) (68eb087)
• deps-dev: bump @types/node from 12.7.1 to 12.7.2 (#19) (b1f93d8)
• deps-dev: bump typescript from 3.6.2 to 3.7.2 (#52) (05e421b)
• deps are chores in a library by default (9af7e21)