apipost-cli 1.0.8 → 1.0.13

package/dist/apipost-cli/node_modules/@azure/core-paging/types/3.1/core-paging.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 {};

package/dist/apipost-cli/node_modules/@azure/core-paging/types/3.1/samples-dev/getPagedAsyncIteratorSample.d.ts

@@ -0,0 +1,2 @@
+export declare function main(): Promise<void>;
+//# sourceMappingURL=getPagedAsyncIteratorSample.d.ts.map

package/dist/apipost-cli/node_modules/@azure/core-paging/types/3.1/src/getPagedAsyncIterator.d.ts

@@ -0,0 +1,10 @@
+import { PageSettings, PagedAsyncIterableIterator, PagedResult } from "./models";
+/**
+ * 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>;
+//# sourceMappingURL=getPagedAsyncIterator.d.ts.map

package/dist/apipost-cli/node_modules/@azure/core-paging/types/3.1/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./models";
+export * from "./getPagedAsyncIterator";
+//# sourceMappingURL=index.d.ts.map

package/dist/apipost-cli/node_modules/@azure/core-paging/types/3.1/src/models.d.ts

@@ -0,0 +1,69 @@
+/**
+ * An interface that tracks the settings for paged iteration
+ */
+export 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;
+}
+/**
+ * An interface that allows async iterable iteration both to completion and by page.
+ */
+export 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 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[];
+}
+/**
+ * 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;
+};
+//# sourceMappingURL=models.d.ts.map

package/dist/apipost-cli/node_modules/@azure/core-paging/types/3.1/test/getPagedAsyncIterator.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=getPagedAsyncIterator.spec.d.ts.map