@koine/utils 1.0.69 → 1.0.72

package/buildUrlQueryString.d.ts

@@ -8,5 +8,5 @@ import { type AnyQueryParams } from "./location";
  *
  * @category location
  */
-export declare function buildUrlQueryString(params?: AnyQueryParams): string;
+export declare function buildUrlQueryString<T extends AnyQueryParams>(params: T): string;
 export default buildUrlQueryString;

package/buildUrlQueryString.js

@@ -1,5 +1,6 @@
 import isNull from "./isNull";
 import isUndefined from "./isUndefined";
+import isArray from "./isArray";
 /**
  * Get clean query string for URL
  *
@@ -10,11 +11,17 @@ import isUndefined from "./isUndefined";
  * @category location
  */
 export function buildUrlQueryString(params) {
-    if (params === void 0) { params = {}; }
     var output = "";
+    if (!params)
+        return output;
     for (var key in params) {
         var value = params[key];
-        if (!isNull(value) && !isUndefined(value)) {
+        if (isArray(value)) {
+            for (var i = 0; i < value.length; i++) {
+                output += "".concat(key, "=").concat(encodeURIComponent(value[i] + ""), "&");
+            }
+        }
+        else if (!isNull(value) && !isUndefined(value)) {
             output += "".concat(key, "=").concat(encodeURIComponent(value + ""), "&");
         }
     }

package/createStorage.d.ts

@@ -1,11 +1,52 @@
+declare type NullableRecord<T> = {
+    [K in keyof T]: T[K] | null;
+};
 export declare type CreateStorageConfig = Record<string, any>;
+/**
+ * Utility to create a storage instance to interact with `localStorage` using
+ * encrypted (encoded) key/values.
+ */
 export declare const createStorage: <T extends CreateStorageConfig>(config: Partial<T>) => {
+    /**
+     * Get all storage value (it uses `localStorage.get()`).
+     *
+     * Unparseable values with `JSON.parse()` return their value as it is.
+     * If the given `key` argument is not found `null` is returned.
+     */
     get<TKey extends keyof T>(key: TKey): T[TKey] | null;
+    /**
+     * Get all storage values (it uses `localStorage.get()`).
+     */
+    getAll(): NullableRecord<T>;
+    /**
+     * Set a storage value (it uses `localStorage.set()`).
+     *
+     * Non-string values are stringified with `JSON.stringify()`
+     */
     set<TKey_1 extends keyof T>(key: TKey_1, value: T[TKey_1]): void;
+    /**
+     * Set all given storage values (it uses `localStorage.set()`).
+     *
+     * Non-string values are stringified with `JSON.stringify()`, `undefined`
+     * and `null` values are removed from the storage
+     */
+    setMany(newValues: Partial<T>): void;
+    /**
+     * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
+     */
     has<TKey_2 extends keyof T>(key: TKey_2): boolean;
+    /**
+     * Remove a storage value (it uses `localStorage.remove()`).
+     */
     remove<TKey_3 extends keyof T>(key: TKey_3): void;
+    /**
+     * Clear all storage values (it uses `localStorage.remove()`).
+     */
     clear(): void;
     /**
+     * Watch a storage value changes, this needs to be executed only in browser
+     * context (it uses `window.addEventListener("storage")`).
+     *
      * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
      */
     watch: <TKey_4 extends keyof T>(keyToWatch: TKey_4, onRemoved?: () => void, onAdded?: () => void) => () => void;

package/createStorage.js

@@ -1,8 +1,13 @@
 import { __assign } from "tslib";
 import { decode } from "./decode";
 import { encode } from "./encode";
-import isBrowser from "./isBrowser";
+import { isBrowser } from "./isBrowser";
+import { isUndefined } from "./isUndefined";
 import { isString } from "./isString";
+/**
+ * Utility to create a storage instance to interact with `localStorage` using
+ * encrypted (encoded) key/values.
+ */
 export var createStorage = function (config) {
     var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
     /**
@@ -22,6 +27,12 @@ export var createStorage = function (config) {
         return (__assign(__assign({}, map), (_a = {}, _a[key] = encode(key), _a)));
     }, {});
     return {
+        /**
+         * Get all storage value (it uses `localStorage.get()`).
+         *
+         * Unparseable values with `JSON.parse()` return their value as it is.
+         * If the given `key` argument is not found `null` is returned.
+         */
         get: function (key) {
             var stored = ls("g", keys[key]);
             if (stored) {
@@ -35,22 +46,66 @@ export var createStorage = function (config) {
             }
             return null;
         },
+        /**
+         * Get all storage values (it uses `localStorage.get()`).
+         */
+        getAll: function () {
+            var all = {};
+            for (var key in keys) {
+                all[key] = this.get(key);
+            }
+            return all;
+        },
+        /**
+         * Set a storage value (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`
+         */
         set: function (key, value) {
             ls("s", keys[key], isString(value) ? encode(value) : encode(JSON.stringify(value)));
         },
+        /**
+         * Set all given storage values (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`, `undefined`
+         * and `null` values are removed from the storage
+         */
+        setMany: function (newValues) {
+            for (var key in newValues) {
+                var value = newValues[key];
+                if (!isUndefined(value)) {
+                    this.set(key, value);
+                }
+                else {
+                    this.remove(key);
+                }
+            }
+        },
+        /**
+         * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
+         */
         has: function (key) {
             var stored = ls("g", keys[key]);
             return !!stored;
         },
+        /**
+         * Remove a storage value (it uses `localStorage.remove()`).
+         */
         remove: function (key) {
             ls("r", keys[key]);
         },
+        /**
+         * Clear all storage values (it uses `localStorage.remove()`).
+         */
         clear: function () {
             for (var key in keys) {
                 ls("r", keys[key]);
             }
         },
         /**
+         * Watch a storage value changes, this needs to be executed only in browser
+         * context (it uses `window.addEventListener("storage")`).
+         *
          * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
          */
         watch: function (keyToWatch, onRemoved, onAdded) {
@@ -65,6 +120,8 @@ export var createStorage = function (config) {
                     }
                 }
             };
+            if (!isBrowser)
+                return function () { return void 0; };
             window.addEventListener("storage", handler);
             return function () {
                 window.removeEventListener("storage", handler);

package/node/buildUrlQueryString.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildUrlQueryString = void 0;
 var isNull_1 = require("./isNull");
 var isUndefined_1 = require("./isUndefined");
+var isArray_1 = require("./isArray");
 /**
  * Get clean query string for URL
  *
@@ -13,11 +14,17 @@ var isUndefined_1 = require("./isUndefined");
  * @category location
  */
 function buildUrlQueryString(params) {
-    if (params === void 0) { params = {}; }
     var output = "";
+    if (!params)
+        return output;
     for (var key in params) {
         var value = params[key];
-        if (!(0, isNull_1.default)(value) && !(0, isUndefined_1.default)(value)) {
+        if ((0, isArray_1.default)(value)) {
+            for (var i = 0; i < value.length; i++) {
+                output += "".concat(key, "=").concat(encodeURIComponent(value[i] + ""), "&");
+            }
+        }
+        else if (!(0, isNull_1.default)(value) && !(0, isUndefined_1.default)(value)) {
             output += "".concat(key, "=").concat(encodeURIComponent(value + ""), "&");
         }
     }

package/node/createStorage.js

@@ -5,14 +5,19 @@ var tslib_1 = require("tslib");
 var decode_1 = require("./decode");
 var encode_1 = require("./encode");
 var isBrowser_1 = require("./isBrowser");
+var isUndefined_1 = require("./isUndefined");
 var isString_1 = require("./isString");
+/**
+ * Utility to create a storage instance to interact with `localStorage` using
+ * encrypted (encoded) key/values.
+ */
 var createStorage = function (config) {
     var methodsMap = { g: "getItem", s: "setItem", r: "removeItem" };
     /**
      * Super minifiable localStorage wrapper with SSR safety
      */
     var ls = function (method, key, value) {
-        return isBrowser_1.default
+        return isBrowser_1.isBrowser
             ? localStorage[methodsMap[method]](key, value)
             : function () {
                 if (process.env["NODE_ENV"] !== "production") {
@@ -25,6 +30,12 @@ var createStorage = function (config) {
         return (tslib_1.__assign(tslib_1.__assign({}, map), (_a = {}, _a[key] = (0, encode_1.encode)(key), _a)));
     }, {});
     return {
+        /**
+         * Get all storage value (it uses `localStorage.get()`).
+         *
+         * Unparseable values with `JSON.parse()` return their value as it is.
+         * If the given `key` argument is not found `null` is returned.
+         */
         get: function (key) {
             var stored = ls("g", keys[key]);
             if (stored) {
@@ -38,22 +49,66 @@ var createStorage = function (config) {
             }
             return null;
         },
+        /**
+         * Get all storage values (it uses `localStorage.get()`).
+         */
+        getAll: function () {
+            var all = {};
+            for (var key in keys) {
+                all[key] = this.get(key);
+            }
+            return all;
+        },
+        /**
+         * Set a storage value (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`
+         */
         set: function (key, value) {
             ls("s", keys[key], (0, isString_1.isString)(value) ? (0, encode_1.encode)(value) : (0, encode_1.encode)(JSON.stringify(value)));
         },
+        /**
+         * Set all given storage values (it uses `localStorage.set()`).
+         *
+         * Non-string values are stringified with `JSON.stringify()`, `undefined`
+         * and `null` values are removed from the storage
+         */
+        setMany: function (newValues) {
+            for (var key in newValues) {
+                var value = newValues[key];
+                if (!(0, isUndefined_1.isUndefined)(value)) {
+                    this.set(key, value);
+                }
+                else {
+                    this.remove(key);
+                }
+            }
+        },
+        /**
+         * Check if a storage value is _truthy_ (it uses `localStorage.get()`).
+         */
         has: function (key) {
             var stored = ls("g", keys[key]);
             return !!stored;
         },
+        /**
+         * Remove a storage value (it uses `localStorage.remove()`).
+         */
         remove: function (key) {
             ls("r", keys[key]);
         },
+        /**
+         * Clear all storage values (it uses `localStorage.remove()`).
+         */
         clear: function () {
             for (var key in keys) {
                 ls("r", keys[key]);
             }
         },
         /**
+         * Watch a storage value changes, this needs to be executed only in browser
+         * context (it uses `window.addEventListener("storage")`).
+         *
          * Inspiration from [Multi Tab Logout in React — Redux](https://medium.com/front-end-weekly/multi-tab-logout-in-react-redux-4715f071c7fa)
          */
         watch: function (keyToWatch, onRemoved, onAdded) {
@@ -68,6 +123,8 @@ var createStorage = function (config) {
                     }
                 }
             };
+            if (!isBrowser_1.isBrowser)
+                return function () { return void 0; };
             window.addEventListener("storage", handler);
             return function () {
                 window.removeEventListener("storage", handler);

package/package.json

@@ -7,7 +7,7 @@
   "peerDependencies": {
     "tslib": "^2.4.0"
   },
-  "version": "1.0.69",
+  "version": "1.0.72",
   "module": "./index.js",
   "types": "./index.d.ts"
 }