docs: add jsdocs to Paginated

Co-authored-by: Charly Chevalier <charly.chevalier@consensys.net>
MetaMask · Oct 18, 2024 · b96a9a7 · b96a9a7
1 parent 189e7f3
commit b96a9a7
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/keyring-api/src/utils/pagination.ts b/packages/keyring-api/src/utils/pagination.ts
@@ -51,6 +51,13 @@ export type Pagination = Infer<typeof PaginationStruct>;
  * ```
  */
 export type Paginated<Type> = {
+  /**
+   * The list of items for this page.
+   */
   data: Type[];
+
+  /**
+   * Next cursor to iterate over the results if any, will be `null` otherwise.
+   */
   next: string | null;
 };