atomic-fns 0.2.0 → 0.2.2

package/.esdoc.json

@@ -3,7 +3,25 @@
   "destination": "./docs",
   "plugins": [
     {
-      "name": "esdoc-standard-plugin"
+      "name": "esdoc-standard-plugin",
+      "option": {
+        "test": {
+          "source": "./tests/",
+          "interfaces": [
+            "describe",
+            "it",
+            "context",
+            "suite",
+            "test"
+          ],
+          "includes": [
+            "(spec|Spec|test|Test)\\.ts$"
+          ],
+          "excludes": [
+            "\\.config\\.js$"
+          ]
+        }
+      }
     }
   ]
 }

package/.eslintrc.json

@@ -26,6 +26,7 @@
     "@typescript-eslint/explicit-function-return-type": "off",
     "@typescript-eslint/no-dynamic-delete": "off",
     "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
     "@typescript-eslint/restrict-plus-operands": "off",
     "@typescript-eslint/space-before-function-paren": "off",
     "@typescript-eslint/strict-boolean-expressions": "off",

package/README.md

@@ -2,7 +2,7 @@
 
 ## Like Lodash, but for ESNext and with types.
 
-Stop shipping code built for browsers from 2015. Really though, look at the [issues](https://github.com/lodash/lodash/issues/2930#issuecomment-370295020).
+Stop shipping code built for browsers from 2015. Really though, look at the [issues](https://github.com/lodash/lodash/issues/2930).
 
 * **Modular**: Pick what you need. Works with all bundlers and also supports tree-shaking.
 * **ESNext**: Uses modern idiomatic syntax, data structures, and control flow techniques.
@@ -20,7 +20,7 @@ npm install atomic-fns
 
 ## How to use
 ```typescript
-import { id, reversed, sorted, times, uniqueId } from 'atomic-fns'
+import { reversed, sorted, times, uniqueId } from 'atomic-fns'
 
 reverse([1, 2, 3, 4])
 // -> [4, 3, 2, 1]
@@ -28,10 +28,7 @@ reverse([1, 2, 3, 4])
 sorted([4, 3, 2, 1])
 // -> [1, 2, 3, 4]
 
-times(5, id)
-// -> [0, 1, 2, 3, 4]
-
-times(5, id)
+times(5, (i) => i)
 // -> [0, 1, 2, 3, 4]
 
 uniqueId('user_')

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "atomic-fns",
   "description": "Like Lodash, but for ESNext and with types. Stop shipping code built for browsers from 2015.",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "main": "src/index.js",
   "type": "module",
   "devDependencies": {
@@ -23,23 +23,24 @@
     "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
     "ts-node": "^10.4.1",
+    "typedoc": "^0.23.16",
     "typescript": "^4.8.4"
   },
   "scripts": {
-    "prepublishOnly": "npm test && npm run tsc",
+    "prepublishOnly": "npm test",
     "test": "NODE_OPTIONS=--loader=ts-node/esm jasmine --config=jasmine.json",
     "tsc": "tsc -p ./tsconfig.xo.json --declaration",
     "lint": "eslint src/**",
     "lint:fix": "eslint src/** --fix",
-    "format": "prettier --write src/**",
-    "docs": "npm run tsc && esdoc"
+    "build": "npm run tsc && npm run lint:fix",
+    "docs": "typedoc --mode modules"
   },
   "lint-staged": {
     "*.ts": "eslint"
   },
   "husky": {
     "hooks": {
-      "precommit": "npm test && lint-staged && pretty-quick --staged"
+      "precommit": "lint-staged && pretty-quick --staged"
     }
   },
   "repository": {

package/src/collections.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Collections
+ * @module
+ */
 import { Function, Iteratee } from './globals.js';
 /**
  * A container type that provides contains().