@azure/core-paging 1.4.0 → 1.5.0

package/dist-esm/src/models.js.map

@@ -1 +1 @@
-{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * An interface that tracks the settings for paged iteration\n */\nexport interface PageSettings {\n  /**\n   * The token that keeps track of where to continue the iterator\n   */\n  continuationToken?: string;\n  /**\n   * The size of the page during paged iteration\n   */\n  maxPageSize?: number;\n}\n/**\n * An interface that allows async iterable iteration both to completion and by page.\n */\nexport interface PagedAsyncIterableIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings = PageSettings\n> {\n  /**\n   * The next method, part of the iteration protocol\n   */\n  next(): Promise<IteratorResult<TElement>>;\n  /**\n   * The connection to the async iterator, part of the iteration protocol\n   */\n  [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;\n  /**\n   * Return an AsyncIterableIterator that works a page at a time\n   */\n  byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n}\n\n/**\n * An interface that describes how to communicate with the service.\n */\nexport interface PagedResult<TPage, TPageSettings = PageSettings, TLink = string> {\n  /**\n   * Link to the first page of results.\n   */\n  firstPageLink: TLink;\n  /**\n   * A method that returns a page of results.\n   */\n  getPage: (\n    pageLink: TLink,\n    maxPageSize?: number\n  ) => Promise<{ page: TPage; nextPageLink?: TLink } | undefined>;\n  /**\n   * a function to implement the `byPage` method on the paged async iterator. The default is\n   * one that sets the `maxPageSizeParam` from `settings.maxPageSize`.\n   */\n  byPage?: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n\n  /**\n   * A function to extract elements from a page.\n   */\n  toElements?: (page: TPage) => unknown[];\n}\n"]}
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * An interface that tracks the settings for paged iteration\n */\nexport interface PageSettings {\n  /**\n   * The token that keeps track of where to continue the iterator\n   */\n  continuationToken?: string;\n  /**\n   * The size of the page during paged iteration\n   */\n  maxPageSize?: number;\n}\n/**\n * An interface that allows async iterable iteration both to completion and by page.\n */\nexport interface PagedAsyncIterableIterator<\n  TElement,\n  TPage = TElement[],\n  TPageSettings = PageSettings\n> {\n  /**\n   * The next method, part of the iteration protocol\n   */\n  next(): Promise<IteratorResult<TElement>>;\n  /**\n   * The connection to the async iterator, part of the iteration protocol\n   */\n  [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;\n  /**\n   * Return an AsyncIterableIterator that works a page at a time\n   */\n  byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n}\n\n/**\n * An interface that describes how to communicate with the service.\n */\nexport interface PagedResult<TPage, TPageSettings = PageSettings, TLink = string> {\n  /**\n   * Link to the first page of results.\n   */\n  firstPageLink: TLink;\n  /**\n   * A method that returns a page of results.\n   */\n  getPage: (\n    pageLink: TLink,\n    maxPageSize?: number\n  ) => Promise<{ page: TPage; nextPageLink?: TLink } | undefined>;\n  /**\n   * a function to implement the `byPage` method on the paged async iterator. The default is\n   * one that sets the `maxPageSizeParam` from `settings.maxPageSize`.\n   */\n  byPage?: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;\n\n  /**\n   * A function to extract elements from a page.\n   */\n  toElements?: (page: TPage) => unknown[];\n}\n\n/**\n * Paged collection of T items\n */\nexport type Paged<T> = {\n  /**\n   * The T items on this page\n   */\n  value: T[];\n  /**\n   * The link to the next page of items\n   */\n  nextLink?: string;\n};\n"]}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@azure/core-paging",
   "author": "Microsoft Corporation",
   "sdk-type": "client",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Core types for paging async iterable iterators",
   "tags": [
     "microsoft",
@@ -95,7 +95,7 @@
     "mocha-junit-reporter": "^2.0.0",
     "prettier": "^2.5.1",
     "rimraf": "^3.0.0",
-    "typescript": "~4.6.0"
+    "typescript": "~4.8.0"
   },
   "//sampleConfiguration": {
     "skipFolder": true,

package/types/3.1/core-paging.d.ts

@@ -6,6 +6,19 @@
  * @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.
  */

package/types/3.1/src/models.d.ts

@@ -53,4 +53,17 @@ export interface PagedResult<TPage, TPageSettings = PageSettings, TLink = string
      */
     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/types/latest/core-paging.d.ts

@@ -7,6 +7,20 @@
  */
 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.
  */