feat: add pagination global types (#1443)

* feat: add pagination global types
aws · Aug 19, 2020 · d12f9ba · d12f9ba
1 parent 5478012
commit d12f9ba
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/packages/types/src/pagination.ts b/packages/types/src/pagination.ts
@@ -0,0 +1,16 @@
+import { Client } from "@aws-sdk/types";
+
+/**
+ * Expected type definition of a paginator.
+ */
+export type Paginator<T> = AsyncGenerator<T, T, unknown>;
+
+/**
+ * Expected paginator configuration passed to an operation. Services will extend
+ * this interface definition and may type client further.
+ */
+export interface PaginationConfiguration {
+  client: Client<any, any, any>;
+  pageSize?: number;
+  startingToken?: string;
+}