first commit

wangzhibo

2026-05-09 53418655c061ac26f66058253f39200aced1ab1d

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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/** 
 * returns an async iterator that iterates over results. It also has a `byPage` 
 * method that returns pages of items at once. 
 * 
 * @param pagedResult - an object that specifies how to get pages. 
 * @returns a paged async iterator that iterates over results. 
 */ 
export declare function getPagedAsyncIterator<TElement, TPage = TElement[], TPageSettings = PageSettings, TLink = string>(pagedResult: PagedResult<TPage, TPageSettings, TLink>): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>; 
 
/** 
 * Paged collection of T items 
 */ 
export declare type Paged<T> = { 
    /** 
     * The T items on this page 
     */ 
    value: T[]; 
    /** 
     * The link to the next page of items 
     */ 
    nextLink?: string; 
}; 
 
/** 
 * An interface that allows async iterable iteration both to completion and by page. 
 */ 
export declare interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> { 
    /** 
     * The next method, part of the iteration protocol 
     */ 
    next(): Promise<IteratorResult<TElement>>; 
    /** 
     * The connection to the async iterator, part of the iteration protocol 
     */ 
    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>; 
    /** 
     * Return an AsyncIterableIterator that works a page at a time 
     */ 
    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>; 
} 
 
/** 
 * An interface that describes how to communicate with the service. 
 */ 
export declare interface PagedResult<TPage, TPageSettings = PageSettings, TLink = string> { 
    /** 
     * Link to the first page of results. 
     */ 
    firstPageLink: TLink; 
    /** 
     * A method that returns a page of results. 
     */ 
    getPage: (pageLink: TLink, maxPageSize?: number) => Promise<{ 
        page: TPage; 
        nextPageLink?: TLink; 
    } | undefined>; 
    /** 
     * a function to implement the `byPage` method on the paged async iterator. The default is 
     * one that sets the `maxPageSizeParam` from `settings.maxPageSize`. 
     */ 
    byPage?: (settings?: TPageSettings) => AsyncIterableIterator<TPage>; 
    /** 
     * A function to extract elements from a page. 
     */ 
    toElements?: (page: TPage) => unknown[]; 
} 
 
/** 
 * An interface that tracks the settings for paged iteration 
 */ 
export declare interface PageSettings { 
    /** 
     * The token that keeps track of where to continue the iterator 
     */ 
    continuationToken?: string; 
    /** 
     * The size of the page during paged iteration 
     */ 
    maxPageSize?: number; 
} 
 
export { }