Package Exports

@azure/core-paging

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@azure/core-paging) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Azure Core Paging client library for JavaScript

This library provides core types for paging async iterable iterators.

Getting started

Installation

If using this as part of another project in the azure-sdk-for-js repo, then run rush install after cloning the repo.

Otherwise, use npm to install this package in your application as follows

npm install @azure/core-paging

Key concepts

You can find an explanation of how this repository's code works by going to our architecture overview.

Examples

Example of building with the types:

  public listSecrets(
    options?: ListSecretsOptions
  ): PagedAsyncIterableIterator<SecretAttributes> {
    const iter = this.listSecretsAll(options);
    return {
      async next() {
        const item = (await iter.next()).value;
        return item ? { done: false, value: item } : { done: true, value: undefined };
      },
      [Symbol.asyncIterator](https://github.com/Azure/azure-sdk-for-js/tree/1278511d2aecc4567cf9214e0fac90d3f7e9a03e/sdk/core/core-paging) { return this; },
      byPage: (settings: PageSettings = {}) => this.listSecretsPage(settings, options),
    };
  }

And using the types:

  for await (let page of client.listSecrets().byPage({ pageSize: 2 })) {
    for (const secret of page) {
      console.log("secret: ", secret);
    }
  }

Next steps

Try out this package in your application when dealing with async iterable iterators and provide feedback!

Troubleshooting

Log an issue at https://github.com/Azure/azure-sdk-for-js/issues

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Impressions