@stryke/helpers 0.7.2 → 0.8.0

package/README.md

@@ -49,20 +49,22 @@ other Stryke projects.
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 ## Table of Contents
 
-- [Quick Features](#quick-features)
-- [Installing](#installing)
-- [Reduced Package Size](#reduced-package-size)
-- [Development](#development)
-  - [Building](#building)
-  - [Running unit tests](#running-unit-tests)
-  - [Linting](#linting)
-- [Storm Workspaces](#storm-workspaces)
-- [Roadmap](#roadmap)
-- [Support](#support)
-- [License](#license)
-- [Changelog](#changelog)
-- [Contributing](#contributing)
-- [Contributors](#contributors)
+- [Stryke - Helper Functions](#stryke---helper-functions)
+  - [Table of Contents](#table-of-contents)
+  - [Quick Features](#quick-features)
+  - [Installing](#installing)
+  - [Reduced Package Size](#reduced-package-size)
+  - [Development](#development)
+    - [Building](#building)
+    - [Running unit tests](#running-unit-tests)
+    - [Linting](#linting)
+  - [Storm Workspaces](#storm-workspaces)
+  - [Roadmap](#roadmap)
+  - [Support](#support)
+  - [License](#license)
+  - [Changelog](#changelog)
+  - [Contributing](#contributing)
+  - [Contributors](#contributors)
 
 <!-- END doctoc -->
 
@@ -89,6 +91,8 @@ The following modules are available in this package:
 - **match-sorter**: Provides a function to sort an array based on a search
   query.
 - **noop**: Provides a no-operation function.
+- **once**: Provides a function that executes another function only once.
+- **memoize**: Provides a function that memoizes the result of another function.
 - **remove-accents**: Provides a function to remove accents from a string.
 - **remove-empty-items**: Provides a function to remove empty items from an
   array.

package/dist/debounce.mjs

@@ -1 +1 @@
-export function debounce(o,u,{signal:t}={}){let e=null;const n=(...r)=>{e!==null&&clearTimeout(e),!t?.aborted&&(e=setTimeout(()=>{o(...r),e=null},u))},l=()=>{n.cancel()};return n.cancel=()=>{e!==null&&(clearTimeout(e),e=null)},t?.addEventListener("abort",l,{once:!0}),n}
+export function debounce(o,u,{signal:t}={}){let e=null;const n=((...r)=>{e!==null&&clearTimeout(e),!t?.aborted&&(e=setTimeout(()=>{o(...r),e=null},u))}),l=()=>{n.cancel()};return n.cancel=()=>{e!==null&&(clearTimeout(e),e=null)},t?.addEventListener("abort",l,{once:!0}),n}

package/dist/index.cjs

@@ -146,6 +146,17 @@ Object.keys(_matchSorter).forEach(function (key) {
     }
   });
 });
+var _memoize = require("./memoize.cjs");
+Object.keys(_memoize).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _memoize[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _memoize[key];
+    }
+  });
+});
 var _mutex = require("./mutex.cjs");
 Object.keys(_mutex).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
@@ -179,6 +190,17 @@ Object.keys(_omit).forEach(function (key) {
     }
   });
 });
+var _once = require("./once.cjs");
+Object.keys(_once).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _once[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _once[key];
+    }
+  });
+});
 var _pick = require("./pick.cjs");
 Object.keys(_pick).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/index.d.ts

@@ -11,9 +11,11 @@ export * from "./get-unique";
 export * from "./identity";
 export * from "./is-equal";
 export * from "./match-sorter";
+export * from "./memoize";
 export * from "./mutex";
 export * from "./noop";
 export * from "./omit";
+export * from "./once";
 export * from "./pick";
 export * from "./remove-accents";
 export * from "./remove-empty-items";

package/dist/index.mjs

@@ -1 +1 @@
-export*from"./arg-identity";export*from"./debounce";export*from"./deep-clone";export*from"./deep-merge";export*from"./delay";export*from"./filter-empty";export*from"./flatten-object";export*from"./get-field";export*from"./get-ordered-by";export*from"./get-unique";export*from"./identity";export*from"./is-equal";export*from"./match-sorter";export*from"./mutex";export*from"./noop";export*from"./omit";export*from"./pick";export*from"./remove-accents";export*from"./remove-empty-items";export*from"./semaphore";export*from"./set-field";export*from"./throttle";export*from"./timeout";export*from"./to-deep-key";export*from"./to-path";export*from"./unflatten-object";export*from"./union";export*from"./with-timeout";
+export*from"./arg-identity";export*from"./debounce";export*from"./deep-clone";export*from"./deep-merge";export*from"./delay";export*from"./filter-empty";export*from"./flatten-object";export*from"./get-field";export*from"./get-ordered-by";export*from"./get-unique";export*from"./identity";export*from"./is-equal";export*from"./match-sorter";export*from"./memoize";export*from"./mutex";export*from"./noop";export*from"./omit";export*from"./once";export*from"./pick";export*from"./remove-accents";export*from"./remove-empty-items";export*from"./semaphore";export*from"./set-field";export*from"./throttle";export*from"./timeout";export*from"./to-deep-key";export*from"./to-path";export*from"./unflatten-object";export*from"./union";export*from"./with-timeout";

package/dist/memoize.cjs

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.memoizeOnId = void 0;
+const memoizeOnId = e => {
+  const n = Object.prototype.hasOwnProperty,
+    t = {};
+  return r => n.call(t, r) ? t[r] : t[r] = e(r);
+};
+exports.memoizeOnId = memoizeOnId;

package/dist/memoize.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Memoizes a function based on its string identifier.
+ *
+ * @param fn - The function to memoize.
+ * @returns A memoized version of the input function.
+ */
+export declare const memoizeOnId: <T>(fn: (id: string) => T) => (id: string) => T;

package/dist/memoize.mjs

@@ -0,0 +1 @@
+export const memoizeOnId=e=>{const n=Object.prototype.hasOwnProperty,t={};return r=>n.call(t,r)?t[r]:t[r]=e(r)};

package/dist/once.cjs

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.once = once;
+exports.safeFunctionCast = safeFunctionCast;
+function safeFunctionCast(n) {
+  return n;
+}
+function once(n) {
+  let e,
+    t = !1;
+  return function (...u) {
+    return t || (e = n.apply(this, u), t = !0), e;
+  };
+}

package/dist/once.d.ts

@@ -0,0 +1,9 @@
+/** silence "error TS2322" but practically this is safer and more convenient than resorting to `any` in a random place */
+export declare function safeFunctionCast<TFunc extends (...args: any[]) => any>(fn: (...args: Parameters<TFunc>) => ReturnType<TFunc>): TFunc;
+/**
+ * Executes a function only once.
+ *
+ * @param fn - The function to be executed only once.
+ * @returns A function that, when called, will execute the original function only once.
+ */
+export declare function once<TFunc extends (...args: any[]) => any>(fn: TFunc): TFunc;

package/dist/once.mjs

@@ -0,0 +1 @@
+export function safeFunctionCast(n){return n}export function once(n){let e,t=!1;return function(...u){return t||(e=n.apply(this,u),t=!0),e}}

package/dist/throttle.mjs

@@ -1 +1 @@
-export function throttle(e,o){let t;return(...l)=>{const n=Date.now();(t==null||n-t>=o)&&(t=n,e(...l))}}
+export function throttle(e,o){let t;return((...l)=>{const n=Date.now();(t==null||n-t>=o)&&(t=n,e(...l))})}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/helpers",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "type": "module",
   "description": "A package containing miscellaneous helper functions that are used across many different Storm Software projects.",
   "repository": {
@@ -12,8 +12,8 @@
   "publishConfig": { "access": "public" },
   "dependencies": {
     "@stryke/convert": "^0.3.1",
-    "@stryke/type-checks": "^0.3.8",
-    "@stryke/types": "^0.8.8"
+    "@stryke/type-checks": "^0.3.9",
+    "@stryke/types": "^0.8.9"
   },
   "devDependencies": {},
   "sideEffects": false,
@@ -212,6 +212,11 @@
       "require": { "types": "./dist/pick.d.ts", "default": "./dist/pick.cjs" },
       "default": { "types": "./dist/pick.d.ts", "default": "./dist/pick.mjs" }
     },
+    "./once": {
+      "import": { "types": "./dist/once.d.ts", "default": "./dist/once.mjs" },
+      "require": { "types": "./dist/once.d.ts", "default": "./dist/once.cjs" },
+      "default": { "types": "./dist/once.d.ts", "default": "./dist/once.mjs" }
+    },
     "./omit": {
       "import": { "types": "./dist/omit.d.ts", "default": "./dist/omit.mjs" },
       "require": { "types": "./dist/omit.d.ts", "default": "./dist/omit.cjs" },
@@ -230,6 +235,20 @@
       },
       "default": { "types": "./dist/mutex.d.ts", "default": "./dist/mutex.mjs" }
     },
+    "./memoize": {
+      "import": {
+        "types": "./dist/memoize.d.ts",
+        "default": "./dist/memoize.mjs"
+      },
+      "require": {
+        "types": "./dist/memoize.d.ts",
+        "default": "./dist/memoize.cjs"
+      },
+      "default": {
+        "types": "./dist/memoize.d.ts",
+        "default": "./dist/memoize.mjs"
+      }
+    },
     "./match-sorter": {
       "import": {
         "types": "./dist/match-sorter.d.ts",
@@ -441,5 +460,5 @@
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "gitHead": "7aac00edc2ff843fb756d37cdcaf482e2da4472b"
+  "gitHead": "a27f10e735a05cca18b29026136249ed3bb76c1c"
 }