Merge pull request #60 from honey32/develop

prepare for v1.1.0

Author: honey32

.eslintrc.js

@@ -19,5 +19,8 @@ module.exports = {
     'jest'
   ],
   rules: {
+    // workaround: to allow overload. 
+    // TODO: re-write for typescript
+    'no-redeclare': 'off',
   }
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "next-query-utils",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "source": "src/index.ts",
   "main": "dist/main.js",
   "module": "dist/module.js",
@@ -63,17 +63,17 @@
     "eslint-plugin-jest": "^26.2.2",
     "eslint-plugin-n": "^15.2.0",
     "eslint-plugin-promise": "^6.0.0",
-    "jest": "^28.1.0",
+    "jest": "^29.5.0",
     "lint-staged": "^12.4.1",
     "npm-run-all": "^4.1.5",
-    "parcel": "^2.5.0",
+    "parcel": "^2.9.3",
     "prettier": "^2.6.2",
     "simple-git-hooks": "^2.7.0",
-    "ts-jest": "^28.0.2",
-    "typedoc": "^0.22.15",
-    "typescript": "^4.6.4"
+    "ts-jest": "^29.1.0",
+    "typedoc": "^0.24.8",
+    "typescript": "^5.1.3"
   },
   "dependencies": {
-    "@swc/helpers": "^0.3.17"
+    "@swc/helpers": "^0.5.1"
   }
 }

package.json

@@ -25,5 +25,10 @@ describe("getMultipleQueryParams(key, pred)(query)", () => {
     expect(getMultipleQueryParams(query, "key", (s) => s === "a")).toEqual(
       result
     );
+
+    // strictly typed
+    expect<"a"[]>(
+      getMultipleQueryParams(query, "key", (s): s is "a" => s === "a")
+    ).toEqual(result);
   });
 });

src/getters/getMultipleQueryParams.test.ts

@@ -1,5 +1,16 @@
 import { ParsedUrlQuery } from "../types/ParsedUrlQuery";
 
+export function getMultipleQueryParams<T extends string>(
+  query: ParsedUrlQuery,
+  key: string,
+  pred?: (s: string) => s is T
+): T[];
+export function getMultipleQueryParams(
+  query: ParsedUrlQuery,
+  key: string,
+  pred?: (s: string) => boolean
+): string[];
+
 /**
  *
  * Returns an array of the values for the specified *key* in the query object.
@@ -25,16 +36,16 @@ import { ParsedUrlQuery } from "../types/ParsedUrlQuery";
  *
  * @param pred *optional*. the values *that fit this predicate* will be returned.
  */
-export const getMultipleQueryParams = (
+export function getMultipleQueryParams(
   query: ParsedUrlQuery,
   key: string,
   pred: (s: string) => boolean = () => true
-): string[] => {
+): string[] {
   const _value = query[key];
 
   if (!_value) return [];
 
   if (Array.isArray(_value)) return _value.filter(pred);
 
   return pred(_value) ? [_value] : [];
-};
+}

src/getters/getMultipleQueryParams.ts

@@ -23,5 +23,10 @@ describe("getSingleQueryParam(key, pred)(query)", () => {
     [{ key: ["b", "c"] }, undefined],
   ])('(%p, "key", (s) => s === "a") === %s', (query, result) => {
     expect(getSingleQueryParam(query, "key", (s) => s === "a")).toEqual(result);
+
+    // strictly typed
+    expect<"a" | undefined>(
+      getSingleQueryParam(query, "key", (s): s is "a" => s === "a")
+    ).toEqual(result);
   });
 });

src/getters/getSingleQueryParam.test.ts

@@ -1,5 +1,16 @@
 import { ParsedUrlQuery } from "../types/ParsedUrlQuery";
 
+export function getSingleQueryParam<T extends string>(
+  query: ParsedUrlQuery,
+  key: string,
+  pred?: (s: string) => s is T
+): T | undefined;
+export function getSingleQueryParam<T extends string>(
+  query: ParsedUrlQuery,
+  key: string,
+  pred?: (s: string) => boolean
+): T | undefined;
+
 /**
  * Returns the first value for the specified *key* in the query object.
  * If `pred` specified, returns the first value *that meets it*.
@@ -24,16 +35,16 @@ import { ParsedUrlQuery } from "../types/ParsedUrlQuery";
  *
  * @param pred *optional*. the first value *that fits this predicate* will be returned.
  */
-export const getSingleQueryParam = (
+export function getSingleQueryParam(
   query: ParsedUrlQuery,
   key: string,
   pred: (s: string) => boolean = () => true
-): string | undefined => {
+): string | undefined {
   const _value = query[key];
 
   if (!_value) return undefined;
 
   if (Array.isArray(_value)) return _value.filter(pred)[0];
 
   return pred(_value) ? _value : undefined;
-};
+}