mirror of
https://github.com/oven-sh/setup-bun.git
synced 2025-02-24 11:20:24 +08:00
62 lines
1.8 KiB
Markdown
62 lines
1.8 KiB
Markdown
|
# 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](https://github.com/Azure/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
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
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](https://github.com/Azure/ms-rest-js/blob/master/docs/architectureOverview.md).
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
Example of building with the types:
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
public listSecrets(
|
||
|
|
options: ListSecretsOptions = {}
|
||
|
|
): PagedAsyncIterableIterator<SecretAttributes> {
|
||
|
|
const iter = this.listSecretsAll(options);
|
||
|
|
return {
|
||
|
|
async next() { return iter.next(); },
|
||
|
|
[Symbol.asyncIterator]() { return this; },
|
||
|
|
byPage: (settings: PageSettings = {}) => this.listSecretsPage(settings, options),
|
||
|
|
};
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
And using the types:
|
||
|
|
|
||
|
|
```
|
||
|
|
for await (let page of client.listSecrets().byPage({ maxPageSize: 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
|
||
|
|
|
||
|
|
If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/blob/main/CONTRIBUTING.md) to learn more about how to build and test the code.
|
||
|
|
|
||
|
|
|