@webreflection/utils 0.2.5 → 0.2.7

package/README.md

@@ -34,4 +34,9 @@ resolve(4);
 
 boundOnce(Promise).all === all;
 boundOnce(Promise).resolve === resolve;
+
+// example: always retrieve the first time data/module
+import sticky from '@webreflection/utils/sticky';
+
+export default sticky('@module/name', { always: 'same' });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webreflection/utils",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "type": "module",
   "types": {
     "./bound-once": "./types/bound-once.d.ts",
@@ -21,6 +21,10 @@
       "types": "./types/shared-array-buffer.d.ts",
       "import": "./src/shared-array-buffer.js"
     },
+    "./sticky": {
+      "types": "./types/sticky.d.ts",
+      "import": "./src/sticky.js"
+    },
     "./with-resolvers": {
       "types": "./types/with-resolvers.d.ts",
       "import": "./src/with-resolvers.js"
@@ -31,6 +35,7 @@
     "bound-once",
     "bound",
     "shared-array-buffer",
+    "sticky",
     "with-resolvers"
   ],
   "scripts": {

package/src/sticky.js

@@ -0,0 +1,27 @@
+//@ts-check
+
+const { defineProperty } = Object;
+const { for: symbolFor } = Symbol;
+
+/**
+ * Allow leaking a module globally to help avoid conflicting exports
+ * if the module might have been re-bundled in other projects.
+ * @template T
+ * @param {string} name the module name to save or retrieve
+ * @param {T} value the module as value to save if not known
+ * @param {globalThis} [global=globalThis] the reference where modules are saved where `globalThis` is the default
+ * @returns {[T, boolean]} the passed `value` or the previous one as first entry, a boolean indicating if it was known or not
+ */
+export default (name, value, global = globalThis) => {
+  /** @type {symbol} */
+  const symbol = symbolFor(name);
+  const known = symbol in global;
+  return [
+    known ?
+      // @ts-ignore
+      global[symbol] :
+      // @ts-ignore
+      defineProperty(global, symbol, { value })[symbol],
+    known,
+  ];
+};

package/types/sticky.d.ts

@@ -0,0 +1,2 @@
+declare function _default<T>(name: string, value: T, global?: typeof globalThis): [T, boolean];
+export default _default;