getorset-anything 0.0.5 → 1.0.0

package/dist/index.d.ts

@@ -8,11 +8,12 @@ type ValueOfMap<M extends Map<unknown, unknown>> = M extends Map<unknown, infer
  * const map = new Map<string, number[]>()
  *
  * const arr = mapGetOrSet(map, '123', () => [])
+ * //    ↳ []
  *
  * arr.push('xyz')
  * ```
  */
-declare function mapGetOrSet<M extends Map<unknown, unknown>, T extends () => ValueOfMap<M>>(map: M, key: KeyOfMap<M>, initialValue: T): ReturnType<T>;
+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 an object, or if it wasn't found, set an initial value and return that.
  *
@@ -21,10 +22,24 @@ declare function mapGetOrSet<M extends Map<unknown, unknown>, T extends () => Va
  * const obj: Record<string, number[]> = {}
  *
  * const arr = objGetOrSet(obj, '123', () => [])
+ * //    ↳ []
  *
  * arr.push('xyz')
  * ```
  */
-declare function objGetOrSet<O extends Record<string | number | symbol, unknown>, T extends () => O[keyof O]>(obj: O, key: keyof O, initialValue: T): ReturnType<T>;
-
-export { mapGetOrSet, objGetOrSet };
+export declare function objGetOrSet<O extends {
+    [key in string | number | symbol]: unknown;
+}, T extends () => O[keyof O]>(obj: O, key: keyof O, initialValue: T): ReturnType<T>;
+/**
+ * Retrieve the value in an array, or if it wasn't found, set an initial value and return that.
+ *
+ * @example
+ * ```js
+ * const arr: number[] = []
+ *
+ * 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

@@ -1,18 +1,61 @@
-function mapGetOrSet(map, key, initialValue) {
-  let val = map.get(key);
-  if (val === void 0) {
-    val = initialValue();
-    map.set(key, val);
-  }
-  return val;
+/**
+ * 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[]>()
+ *
+ * const arr = mapGetOrSet(map, '123', () => [])
+ * //    ↳ []
+ *
+ * arr.push('xyz')
+ * ```
+ */
+export function mapGetOrSet(map, key, initialValue) {
+    let val = map.get(key);
+    if (val === undefined) {
+        val = initialValue();
+        map.set(key, val);
+    }
+    return val;
 }
-function objGetOrSet(obj, key, initialValue) {
-  let val = obj[key];
-  if (val === void 0) {
-    val = initialValue();
-    obj[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[]> = {}
+ *
+ * const arr = objGetOrSet(obj, '123', () => [])
+ * //    ↳ []
+ *
+ * arr.push('xyz')
+ * ```
+ */
+export function objGetOrSet(obj, key, initialValue) {
+    let val = obj[key];
+    if (val === undefined) {
+        val = initialValue();
+        obj[key] = val;
+    }
+    return val;
+}
+/**
+ * Retrieve the value in an array, or if it wasn't found, set an initial value and return that.
+ *
+ * @example
+ * ```js
+ * const arr: number[] = []
+ *
+ * const val = arrGetOrSet(arr, 0, () => 123)
+ * //    ↳ 123
+ * ```
+ */
+export function arrGetOrSet(arr, index, initialValue) {
+    let val = arr[index];
+    if (val === undefined) {
+        val = initialValue();
+        arr[index] = val;
+    }
+    return val;
 }
-
-export { mapGetOrSet, objGetOrSet };

package/package.json

@@ -1,12 +1,9 @@
 {
   "name": "getorset-anything",
-  "version": "0.0.5",
+  "version": "1.0.0",
   "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,
-  "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "main": "./dist/index.js",
   "exports": {
     ".": {
       "require": {
@@ -19,22 +16,25 @@
       }
     }
   },
-  "files": [
-    "dist"
-  ],
   "engines": {
-    "node": ">=12.13"
+    "node": ">=18"
   },
   "scripts": {
-    "lint": "tsc --noEmit && eslint ./src --ext .ts",
+    "lint": "tsc --noEmit && eslint ./src",
     "test": "vitest run",
-    "build": "rollup -c ./rollup.config.js",
-    "release": "npm run lint && del dist && npm run build && np"
+    "build": "del-cli dist && tsc",
+    "release": "npm run lint && npm run build && np"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mesqueeb/getorset-anything.git"
+  "devDependencies": {
+    "del-cli": "^5.1.0",
+    "np": "^10.0.5",
+    "vitest": "^1.6.0",
+    "@cycraft/eslint": "^0.3.0",
+    "@cycraft/tsconfig": "^0.1.2"
   },
+  "files": [
+    "dist"
+  ],
   "keywords": [
     "javascript",
     "map",
@@ -55,57 +55,13 @@
     "getter-setter",
     "setter-getter"
   ],
-  "author": "Luca Ban - Mesqueeb",
+  "author": "Luca Ban - Mesqueeb (https://cycraft.co)",
   "funding": "https://github.com/sponsors/mesqueeb",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/mesqueeb/getorset-anything/issues"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mesqueeb/getorset-anything.git"
   },
   "homepage": "https://github.com/mesqueeb/getorset-anything#readme",
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.2",
-    "@typescript-eslint/parser": "^5.59.2",
-    "del-cli": "^5.0.0",
-    "eslint": "^8.40.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-tree-shaking": "^1.10.0",
-    "np": "^7.7.0",
-    "prettier": "^2.8.8",
-    "rollup": "^3.23.0",
-    "rollup-plugin-dts": "^5.3.0",
-    "rollup-plugin-esbuild": "^5.0.0",
-    "typescript": "^4.9.5",
-    "vitest": "^0.31.0"
-  },
-  "np": {
-    "yarn": false,
-    "branch": "production"
-  },
-  "eslintConfig": {
-    "ignorePatterns": [
-      "node_modules",
-      "dist",
-      "scripts",
-      "test"
-    ],
-    "root": true,
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint",
-      "tree-shaking"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/eslint-recommended",
-      "plugin:@typescript-eslint/recommended",
-      "prettier"
-    ],
-    "rules": {
-      "@typescript-eslint/no-empty-function": "off",
-      "@typescript-eslint/no-explicit-any": "off",
-      "@typescript-eslint/ban-ts-ignore": "off",
-      "tree-shaking/no-side-effects-in-initialization": "error",
-      "@typescript-eslint/ban-ts-comment": "off"
-    }
-  }
+  "bugs": "https://github.com/mesqueeb/getorset-anything/issues"
 }

package/dist/cjs/index.cjs

@@ -1,21 +0,0 @@
-'use strict';
-
-function mapGetOrSet(map, key, initialValue) {
-  let val = map.get(key);
-  if (val === void 0) {
-    val = initialValue();
-    map.set(key, val);
-  }
-  return val;
-}
-function objGetOrSet(obj, key, initialValue) {
-  let val = obj[key];
-  if (val === void 0) {
-    val = initialValue();
-    obj[key] = val;
-  }
-  return val;
-}
-
-exports.mapGetOrSet = mapGetOrSet;
-exports.objGetOrSet = objGetOrSet;

package/dist/cjs/index.d.cts

@@ -1,30 +0,0 @@
-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;
-/**
- * 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[]>()
- *
- * const arr = mapGetOrSet(map, '123', () => [])
- *
- * arr.push('xyz')
- * ```
- */
-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 an object, or if it wasn't found, set an initial value and return that.
- *
- * @example
- * ```js
- * const obj: Record<string, number[]> = {}
- *
- * const arr = objGetOrSet(obj, '123', () => [])
- *
- * arr.push('xyz')
- * ```
- */
-declare function objGetOrSet<O extends Record<string | number | symbol, unknown>, T extends () => O[keyof O]>(obj: O, key: keyof O, initialValue: T): ReturnType<T>;
-
-export { mapGetOrSet, objGetOrSet };