/
PagedAsyncIterableIterator.yml
51 lines (51 loc) · 1.81 KB
/
PagedAsyncIterableIterator.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
### YamlMime:TSType
name: PagedAsyncIterableIterator
uid: '@azure/keyvault-secrets.PagedAsyncIterableIterator'
package: '@azure/keyvault-secrets'
summary: >-
An interface that allows async iterable iteration both to completion and by
page.
fullName: PagedAsyncIterableIterator<TElement, TPage, TPageSettings>
remarks: ''
isDeprecated: false
type: interface
properties:
- name: byPage
uid: '@azure/keyvault-secrets.PagedAsyncIterableIterator.byPage'
package: '@azure/keyvault-secrets'
summary: Return an AsyncIterableIterator that works a page at a time
fullName: byPage
remarks: ''
isDeprecated: false
syntax:
content: 'byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>'
return:
description: ''
type: '(settings?: TPageSettings) => AsyncIterableIterator<TPage>'
methods:
- name: next()
uid: '@azure/keyvault-secrets.PagedAsyncIterableIterator.next'
package: '@azure/keyvault-secrets'
summary: The next method, part of the iteration protocol
remarks: ''
isDeprecated: false
syntax:
content: 'function next(): Promise<IteratorResult<TElement, any>>'
return:
description: ''
type: Promise<IteratorResult<TElement, any>>
- name: '[asyncIterator]()'
uid: '@azure/keyvault-secrets.PagedAsyncIterableIterator.[asyncIterator]'
package: '@azure/keyvault-secrets'
summary: The connection to the async iterator, part of the iteration protocol
remarks: ''
isDeprecated: false
syntax:
content: >-
function [asyncIterator](): PagedAsyncIterableIterator<TElement, TPage,
TPageSettings>
return:
description: ''
type: >-
<xref uid="@azure/keyvault-secrets.PagedAsyncIterableIterator"
/><TElement, TPage, TPageSettings>