getorset-anything 1.0.2 → 1.1.1

package/dist/index.d.ts

@@ -1,31 +1,47 @@
-type KeyOfMap<M extends Map<unknown, unknown>> = M extends Map<infer K, unknown> ? K : never;
-type ValueOfMap<M extends Map<unknown, unknown>> = M extends Map<unknown, infer V> ? V : never;
+export type KeyOfMap<M extends Map<unknown, unknown>> = M extends Map<infer K, unknown> ? K : never;
+export type ValueOfMap<M extends Map<unknown, unknown>> = M extends Map<unknown, infer V> ? V : never;
+export type KeyOfWeakMap<M extends WeakMap<object, unknown>> = M extends WeakMap<infer K, unknown> ? K : never;
+export type ValueOfWeakMap<M extends WeakMap<object, unknown>> = M extends WeakMap<object, infer V> ? V : never;
 /**
  * Retrieve the value in a map, or if it wasn't found, set an initial value and return that.
  *
  * @example
- * ```js
- * const map = new Map<string, number[]>()
+ *   ;```js
+ *   const map = new Map<string, number[]>()
  *
- * const arr = mapGetOrSet(map, '123', () => [])
- * //    ↳ []
+ *   const arr = mapGetOrSet(map, '123', () => [])
+ *   //    ↳ []
  *
- * arr.push('xyz')
- * ```
+ *   arr.push('xyz')
+ *   ```
  */
 export declare function mapGetOrSet<M extends Map<unknown, unknown>, T extends () => ValueOfMap<M>>(map: M, key: KeyOfMap<M>, initialValue: T): ReturnType<T>;
+/**
+ * Retrieve the value in a weak map, or if it wasn't found, set an initial value and return that.
+ *
+ * @example
+ *   ;```js
+ *   const map = new WeakMap<string, number[]>()
+ *
+ *   const arr = weakMapGetOrSet(map, obj, () => [])
+ *   //    ↳ []
+ *
+ *   arr.push('xyz')
+ *   ```
+ */
+export declare function weakMapGetOrSet<M extends WeakMap<object, unknown>, T extends () => ValueOfWeakMap<M>>(map: M, key: KeyOfWeakMap<M>, initialValue: T): ReturnType<T>;
 /**
  * Retrieve the value in an object, or if it wasn't found, set an initial value and return that.
  *
  * @example
- * ```js
- * const obj: Record<string, number[]> = {}
+ *   ;```js
+ *   const obj: Record<string, number[]> = {}
  *
- * const arr = objGetOrSet(obj, '123', () => [])
- * //    ↳ []
+ *   const arr = objGetOrSet(obj, '123', () => [])
+ *   //    ↳ []
  *
- * arr.push('xyz')
- * ```
+ *   arr.push('xyz')
+ *   ```
  */
 export declare function objGetOrSet<O extends {
     [key in string | number | symbol]: unknown;
@@ -34,12 +50,11 @@ export declare function objGetOrSet<O extends {
  * Retrieve the value in an array, or if it wasn't found, set an initial value and return that.
  *
  * @example
- * ```js
- * const arr: number[] = []
+ *   ;```js
+ *   const arr: number[] = []
  *
- * const val = arrGetOrSet(arr, 0, () => 123)
- * //    ↳ 123
- * ```
+ *   const val = arrGetOrSet(arr, 0, () => 123)
+ *   //    ↳ 123
+ *   ```
  */
 export declare function arrGetOrSet<A extends unknown[], T extends () => A[number]>(arr: A, index: number, initialValue: T): ReturnType<T>;
-export {};

package/dist/index.js

@@ -2,14 +2,14 @@
  * Retrieve the value in a map, or if it wasn't found, set an initial value and return that.
  *
  * @example
- * ```js
- * const map = new Map<string, number[]>()
+ *   ;```js
+ *   const map = new Map<string, number[]>()
  *
- * const arr = mapGetOrSet(map, '123', () => [])
- * //    ↳ []
+ *   const arr = mapGetOrSet(map, '123', () => [])
+ *   //    ↳ []
  *
- * arr.push('xyz')
- * ```
+ *   arr.push('xyz')
+ *   ```
  */
 export function mapGetOrSet(map, key, initialValue) {
     let val = map.get(key);
@@ -19,18 +19,39 @@ export function mapGetOrSet(map, key, initialValue) {
     }
     return val;
 }
+/**
+ * Retrieve the value in a weak map, or if it wasn't found, set an initial value and return that.
+ *
+ * @example
+ *   ;```js
+ *   const map = new WeakMap<string, number[]>()
+ *
+ *   const arr = weakMapGetOrSet(map, obj, () => [])
+ *   //    ↳ []
+ *
+ *   arr.push('xyz')
+ *   ```
+ */
+export function weakMapGetOrSet(map, key, initialValue) {
+    let val = map.get(key);
+    if (val === undefined) {
+        val = initialValue();
+        map.set(key, val);
+    }
+    return val;
+}
 /**
  * Retrieve the value in an object, or if it wasn't found, set an initial value and return that.
  *
  * @example
- * ```js
- * const obj: Record<string, number[]> = {}
+ *   ;```js
+ *   const obj: Record<string, number[]> = {}
  *
- * const arr = objGetOrSet(obj, '123', () => [])
- * //    ↳ []
+ *   const arr = objGetOrSet(obj, '123', () => [])
+ *   //    ↳ []
  *
- * arr.push('xyz')
- * ```
+ *   arr.push('xyz')
+ *   ```
  */
 export function objGetOrSet(obj, key, initialValue) {
     let val = obj[key];
@@ -44,12 +65,12 @@ export function objGetOrSet(obj, key, initialValue) {
  * Retrieve the value in an array, or if it wasn't found, set an initial value and return that.
  *
  * @example
- * ```js
- * const arr: number[] = []
+ *   ;```js
+ *   const arr: number[] = []
  *
- * const val = arrGetOrSet(arr, 0, () => 123)
- * //    ↳ 123
- * ```
+ *   const val = arrGetOrSet(arr, 0, () => 123)
+ *   //    ↳ 123
+ *   ```
  */
 export function arrGetOrSet(arr, index, initialValue) {
     let val = arr[index];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "getorset-anything",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "Gets a value from a Map/Obj or sets an initial value when not found and returns that. TypeScript supported.",
   "type": "module",
   "sideEffects": false,
@@ -10,18 +10,12 @@
   "engines": {
     "node": ">=18"
   },
-  "scripts": {
-    "lint": "tsc --noEmit && eslint ./src",
-    "test": "vitest run",
-    "build": "del-cli dist && tsc",
-    "release": "npm run lint && npm run build && np"
-  },
   "devDependencies": {
-    "@cycraft/eslint": "^0.4.3",
+    "@cycraft/eslint": "^0.4.4",
     "@cycraft/tsconfig": "^0.1.2",
-    "del-cli": "^6.0.0",
-    "np": "^10.2.0",
-    "vitest": "^3.0.6"
+    "del-cli": "^7.0.0",
+    "np": "^12.1.1",
+    "vitest": "^5.0.1"
   },
   "files": [
     "dist"
@@ -54,5 +48,11 @@
     "url": "https://github.com/mesqueeb/getorset-anything.git"
   },
   "homepage": "https://github.com/mesqueeb/getorset-anything#readme",
-  "bugs": "https://github.com/mesqueeb/getorset-anything/issues"
-}
+  "bugs": "https://github.com/mesqueeb/getorset-anything/issues",
+  "scripts": {
+    "lint": "tsc --noEmit && eslint ./src",
+    "test": "vitest run",
+    "build": "del-cli dist && tsc",
+    "release": "pnpm run lint && pnpm run build && np"
+  }
+}