Add typedef for pagination

trojs · Jun 21, 2023 · d101b14 · d101b14
1 parent 3ebdb58
commit d101b14
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@hckrnews/paginator",
-    "version": "2.0.0",
+    "version": "2.0.1",
     "description": "Paginator",
     "files": [
         "src/paginator.js",

diff --git a/src/paginator.js b/src/paginator.js
@@ -2,6 +2,12 @@ import { Arr } from '@hckrnews/arrays'
 import { SortDirection } from './enums/sort-direction.js'
 import { cleanUrl } from './clean-url.js'
 
+/**
+ * Get the pagination data
+ * @typedef {{ self: string, prev: string, next: string, first: string, last: string }} Links
+ * @typedef {{ cursors: Links, count: number, pages: number, size: number, page: number, items: object[] }} Pagination
+ */
+
 /**
  * The paginator.
  */
@@ -157,7 +163,6 @@ class Paginator {
 
   /**
    * Get the pagination data
-   * @typedef {{ self: string, prev: string, next: string, first: string, last: string }} Links
    * @returns {{ cursors: Links, count: number, pages: number, size: number, page: number, items: object[] }}
    */
   get data () {