getorset-anything 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Luca Ban - Mesqueeb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# Get or Set Anything 🐊
+
+<a href="https://www.npmjs.com/package/getorset-anything"><img src="https://img.shields.io/npm/v/getorset-anything.svg" alt="Total Downloads"></a>
+<a href="https://www.npmjs.com/package/getorset-anything"><img src="https://img.shields.io/npm/dw/getorset-anything.svg" alt="Latest Stable Version"></a>
+
+```
+npm i getorset-anything
+```
+
+Get a Map/Obj value, or if it didn't exist yet set it and return that. Fully **TypeScript** supported! A simple & small integration.
+
+## Motivation
+
+I created this package because I always hated doing this over and over again:
+
+```ts
+const map = new Map<string, number[]>()
+
+const id = 'abc'
+
+let arr = map.get(id)
+if (arr === undefined) {
+  arr = []
+  map.set(id, arr)
+}
+
+arr.push(100)
+```
+
+So that is exactly what `getorset-anything` does for you! 💯
+
+`getorset-anything` has performance in mind. It won't do a `.has()` check, like other libraries do, when it found the value it will immediately return it.
+
+## Usage
+
+Maps
+
+```ts
+import { mapGetOrSet } from 'getorset-anything'
+
+
+const map = new Map<string, number[]>()
+
+const arr = mapGetOrSet(map, 'abc', () => [])
+
+arr.push(100) // OK!
+```
+
+Objects
+
+```ts
+import { objGetOrSet } from 'getorset-anything'
+
+
+const obj: Record<string, number[]> = {}
+
+const arr = objGetOrSet(obj, 'abc', () => [])
+
+arr.push(100) // OK!
+```
+
+## TypeScript Support
+
+You don't have to do anything extra for TypeScript! It comes with awesome type support.
+
+```ts
+import { mapGetOrSet } from 'getorset-anything'
+
+const map = new Map<string, number[]>()
+
+const arr = mapGetOrSet(map, 'abc', () => []) // OK!
+const arr2 = mapGetOrSet(map, 'abc', () => ({})) // NG! ⛔️
+
+arr.push(100) // OK!
+arr.push('100') // NG! ⛔️
+```
+
+## Meet the family
+
+- [merge-anything 🥡](https://github.com/mesqueeb/merge-anything)
+- [filter-anything ⚔️](https://github.com/mesqueeb/filter-anything)
+- [find-and-replace-anything 🎣](https://github.com/mesqueeb/find-and-replace-anything)
+- [compare-anything 🛰](https://github.com/mesqueeb/compare-anything)
+- [copy-anything 🎭](https://github.com/mesqueeb/copy-anything)
+- [flatten-anything 🏏](https://github.com/mesqueeb/flatten-anything)
+- [is-what 🙉](https://github.com/mesqueeb/is-what)

package/dist/index.cjs

@@ -0,0 +1,47 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * 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')
+ * ```
+ */
+function mapGetOrSet(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[]> = {}
+ *
+ * const arr = objGetOrSet(obj, '123', () => [])
+ *
+ * arr.push('xyz')
+ * ```
+ */
+function objGetOrSet(obj, key, initialValue) {
+    let val = obj[key];
+    if (val === undefined) {
+        val = initialValue();
+        obj[key] = val;
+    }
+    return val;
+}
+
+exports.mapGetOrSet = mapGetOrSet;
+exports.objGetOrSet = objGetOrSet;

package/dist/index.es.js

@@ -0,0 +1,42 @@
+/**
+ * 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')
+ * ```
+ */
+function mapGetOrSet(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[]> = {}
+ *
+ * const arr = objGetOrSet(obj, '123', () => [])
+ *
+ * arr.push('xyz')
+ * ```
+ */
+function objGetOrSet(obj, key, initialValue) {
+    let val = obj[key];
+    if (val === undefined) {
+        val = initialValue();
+        obj[key] = val;
+    }
+    return val;
+}
+
+export { mapGetOrSet, objGetOrSet };

package/dist/types/index.d.ts

@@ -0,0 +1,29 @@
+declare type KeyOfMap<M extends Map<unknown, unknown>> = M extends Map<infer K, unknown> ? K : never;
+declare 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')
+ * ```
+ */
+export declare function mapGetOrSet<M extends Map<unknown, unknown>>(map: M, key: KeyOfMap<M>, initialValue: () => ValueOfMap<M>): ValueOfMap<M>;
+/**
+ * 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 declare function objGetOrSet<O extends Record<string | number | symbol, unknown>>(obj: O, key: keyof O, initialValue: () => O[keyof O]): O[keyof O];
+export {};

package/package.json

@@ -0,0 +1,104 @@
+{
+  "name": "getorset-anything",
+  "version": "0.0.1",
+  "sideEffects": false,
+  "type": "module",
+  "description": "Gets a value from a Map/Obj or sets an initial value when not found and returns that. TypeScript supported.",
+  "module": "./dist/index.es.js",
+  "main": "./dist/index.cjs",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=12.13"
+  },
+  "scripts": {
+    "clean": "del ./dist",
+    "lint": "tsc --noEmit && eslint ./src --ext .ts",
+    "test": "vitest run",
+    "build": "npm run clean && rollup -c ./scripts/build.js",
+    "release": "npm run lint && del dist && npm run build && np"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mesqueeb/getorset-anything.git"
+  },
+  "keywords": [
+    "javascript",
+    "map",
+    "mapgetset",
+    "map-get-or-set",
+    "object-get-or-set",
+    "getorset-anything",
+    "get-or-set",
+    "js-map",
+    "typescript",
+    "map-setter",
+    "object-setter",
+    "obj-set-get",
+    "map-util",
+    "obj-util",
+    "setget"
+  ],
+  "author": "Luca Ban - Mesqueeb",
+  "funding": "https://github.com/sponsors/mesqueeb",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mesqueeb/getorset-anything/issues"
+  },
+  "homepage": "https://github.com/mesqueeb/getorset-anything#readme",
+  "dependencies": {},
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.10.1",
+    "@typescript-eslint/parser": "^5.10.1",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-tree-shaking": "^1.10.0",
+    "np": "^7.6.0",
+    "prettier": "^2.5.1",
+    "rollup": "^2.66.1",
+    "rollup-plugin-typescript2": "^0.31.1",
+    "typescript": "^4.5.5",
+    "vitest": "^0.2.3"
+  },
+  "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"
+    }
+  }
+}