@parameter1/graphql-feature-pagination - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "@parameter1/graphql-feature-pagination",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "type": "module",
@@ -36,3 +36,3 @@ "description": "GraphQL pagination definitions",
   },
-  "gitHead": "4c98ef1feb48bfd22ddec2fd7fc06274bd7194e4"
+  "gitHead": "510a520e89f8b3815992dad0d6750a5baa852061"
 }

src/enums.js

@@ -0,1 +1,4 @@
+/**
+ * @deprecated Do not use.
+ */
 export default {
@@ -2,0 +5,0 @@ /**

src/index.js

@@ -9,8 +9,8 @@ /* eslint-disable max-len */
  * @prop {number} [limit=10] A non-negative value that limits the number of results to return.
- * @prop {CursorPaginationInput} [cursor={}] The cursor pagination options. Will only be applied when using the \`CURSOR\` method.
- * @prop {OffsetPaginationInput} [offset={}] The offset pagination options. Will only be applied when using the \`OFFSET\` method.
+ * @prop {CursorPaginationInput} [cursor={}] The cursor pagination options. Will only be applied when using the `CURSOR` method.
+ * @prop {OffsetPaginationInput} [offset={}] The offset pagination options. Will only be applied when using the `OFFSET` method.
  *
  * @typedef CursorPaginationInput
- * @prop {('AFTER'|'BEFORE')} [direction=AFTER] The cursor direction: either \`AFTER\` (next) or \`BEFORE\` (previous). Defaults to \`AFTER\` (next) pagination.
- * @prop {string|null} [value] The cursor/pointer value to return results from. In \`AFTER\` mode, will return the next results after the provided cursor. In \`BEFORE\` mode, will return the previous results before the provided cursor.
+ * @prop {('AFTER'|'BEFORE')} [direction=AFTER] The cursor direction: either `AFTER` (next) or `BEFORE` (previous). Defaults to `AFTER` (next) pagination.
+ * @prop {string|null} [value] The cursor/pointer value to return results from. In `AFTER` mode, will return the next results after the provided cursor. In `BEFORE` mode, will return the previous results before the provided cursor.
  *
@@ -23,6 +23,6 @@ * @typedef OffsetPaginationInput
  * @prop {boolean} hasPreviousPage Whether a previous page of results exists
- * @prop {string} endCursor The final cursor of the page. Can be used as the \`CursorPaginationInput.cursor\` in \`AFTER\` mode for returning more results. Will be an empty string if no edges could be found.
- * @prop {string} startCursor The first cursor of the page. Can be used as the \`CursorPaginationInput.cursor\` in \`BEFORE\` mode for returning previous results. Will be an empty string if no edges could be found.
- * @prop {number|null} endOffset The final offset of the page. Can be used as the \`OffsetPaginationInput.offset\` for returning more results. Will always be \`null\` when paginating in \`CURSOR\` mode.
- * @prop {number|null} startOffset The first offset of the page. Can be used as the \`OffsetPaginationInput.offset\` for returning previous results. Will always be \`null\` when paginating in \`CURSOR\` mode.
+ * @prop {string} endCursor The final cursor of the page. Can be used as the `CursorPaginationInput.cursor` in `AFTER` mode for returning more results. Will be an empty string if no edges could be found.
+ * @prop {string} startCursor The first cursor of the page. Can be used as the `CursorPaginationInput.cursor` in `BEFORE` mode for returning previous results. Will be an empty string if no edges could be found.
+ * @prop {number|null} endOffset The final offset of the page. Can be used as the `OffsetPaginationInput.offset` for returning more results. Will always be `null` when paginating in `CURSOR` mode.
+ * @prop {number|null} startOffset The first offset of the page. Can be used as the `OffsetPaginationInput.offset` for returning previous results. Will always be `null` when paginating in `CURSOR` mode.
  */

No alert changes

Improved metrics

Total package byte prevSize

6881

0.01%

Lines of code

93

3.33%

No dependency changes