atomic-fns 0.1.1 → 0.2.2

package/.esdoc.json

@@ -0,0 +1,27 @@
+{
+  "source": "./src",
+  "destination": "./docs",
+  "plugins": [
+    {
+      "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,43 +2,42 @@
 
 ## 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.
-* Native: Uses newer data structures and control flow techniques.
-* Lazy: Leverages generators, iterators and functional composition.
-* Fluent: Pure functions and abstract classes. Include only what you need.
-* TypeScript & JSDoc: Supports both TypeScript and latest JS spec. JSDoc for best in class experience.
+* **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.
+* **Lazy**: Leverage generators, iterators, and functional composition.
+* **Fluent**: Pure functions and abstract classes. Include only what you need.
+* **TypeScript & docs**: Includes both type declaration files and js with JSDocs for best in class experience.
+
+## Get Started
 
 This library is available as an npm package. To install the package just run:
 
-```
+```bash
 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]
+// -> [4, 3, 2, 1]
 
 sorted([4, 3, 2, 1])
-// => [1, 2, 3, 4]
-
-times(5, id)
-// => [0, 1, 2, 3, 4]
+// -> [1, 2, 3, 4]
 
-times(5, id)
-// => [0, 1, 2, 3, 4]
+times(5, (i) => i)
+// -> [0, 1, 2, 3, 4]
 
 uniqueId('user_')
-// => 'user_101225005'
+// -> 'user_101225005'
 ```
 
 ## Docs
 
-🛠 Under construction.
+🚢 Coming soon at [atomic-fns.dev](https://atomic-fns.dev).
 
 💡 See the `src` directory for comments.
 

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "atomic-fns",
-  "description": "A general-purpose and forward looking toolbox for evergreen JS code standards.",
-  "version": "0.1.1",
-  "main": "build/index.js",
+  "description": "Like Lodash, but for ESNext and with types. Stop shipping code built for browsers from 2015.",
+  "version": "0.2.2",
+  "main": "src/index.js",
   "type": "module",
   "devDependencies": {
     "@types/jasmine": "^4.3.0",
     "@typescript-eslint/eslint-plugin": "^5.39.0",
+    "esdoc": "^1.1.0",
+    "esdoc-standard-plugin": "^1.0.0",
     "eslint": "^8.25.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-config-standard-with-typescript": "^23.0.0",
@@ -21,32 +23,36 @@
     "prettier": "^2.7.1",
     "pretty-quick": "^3.1.3",
     "ts-node": "^10.4.1",
+    "typedoc": "^0.23.16",
     "typescript": "^4.8.4"
   },
   "scripts": {
-    "postinstall": "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/**"
+    "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": {
     "type": "git",
-    "url": "git+https://github.com/adrian2x/atomic-fns.git"
+    "url": "https://github.com/adrian2x/atomic-fns.git"
   },
   "keywords": [
-    "es-next",
+    "atomic",
+    "atomicfns",
+    "atomic-fns",
     "esnext",
-    "ecmascript",
+    "es-next",
     "@esnext",
     "@es-next",
     "es6",
@@ -56,16 +62,21 @@
     "es2017",
     "es2019",
     "es2020",
+    "es2021",
+    "es2022",
+    "es2023",
+    "lodash",
+    "lazy",
     "modules",
     "stdlib",
     "core-js",
     "util",
     "fp"
   ],
-  "author": "Adrian Cruz <adrian2x>",
+  "author": "Adrian Cruz <kangoonie@gmail.com>",
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/adrian2x/es-next/issues"
+    "url": "https://github.com/adrian2x/atomic-fns/issues"
   },
-  "homepage": "https://github.com/adrian2x/es-next#readme"
-}
+  "homepage": "https://github.com/adrian2x/atomic-fns#readme"
+}

package/{build → src}/collections.d.ts

@@ -1,18 +1,21 @@
-/// <reference path="../src/globals.d.ts" />
+/**
+ * Collections
+ * @module
+ */
 import { Function, Iteratee } from './globals.js';
 /**
  * A container type that provides contains().
  *
- * @export
+ *
  * @interface Container
  */
 export interface Container {
     contains: (x: any) => boolean;
 }
 /**
- * These are the "rich comparison" methods, as in Python.
+ * These are the "rich comparison" methods, inspired by Python operators.
+ *
  *
- * @export
  * @interface Comparable
  */
 export interface Comparable {
@@ -33,7 +36,7 @@ export interface Comparable {
  * A Collection is an iterable container type.
  * This is an abstract base class for user-defined collection types.
  *
- * @export
+ *
  * @abstract
  * @class Collection
  * @implements {Container}
@@ -87,7 +90,7 @@ export interface Reversible<T = unknown> {
 /**
  * A sequence is an iterable type with efficient index-based access.
  *
- * @export
+ *
  * @abstract
  * @class Sequence
  * @extends {Collection}
@@ -141,6 +144,14 @@ export declare abstract class Sequence<T> extends Collection implements Reversib
     size(): number;
     reversed(): Iterator<T>;
 }
+/**
+ * Returns a new immutable Set object with elements from `iterable`. Its contents cannot be altered after it's created.
+ *
+ *
+ * @class FrozenSet
+ * @extends {Set<T>}
+ * @template T
+ */
 export declare class FrozenSet<T = any> extends Set<T> {
     constructor(iterable: Iterable<T>);
     add(): this;
@@ -149,7 +160,20 @@ export declare class FrozenSet<T = any> extends Set<T> {
     freeze(): Readonly<this>;
 }
 export declare const compact: (...arr: any[]) => any[];
-export declare function namedtuple(...fields: string[]): (...args: any[]) => any[][];
+/**
+ * Creates a function that can be used to create named tuple-like objects.
+ * @example
+ * ```
+ * let Point = namedtuple('x', 'y', 'z')
+ * let userObj = User(0, 0, 0)
+ * // -> {x: 0, y: 0, z: 0}
+ * ```
+ *
+ *
+ * @param {...string[]} fields
+ * @return
+ */
+export declare function namedtuple(...fields: string[]): (...args: any[]) => {};
 export declare function filter(arr: any, fn?: Iteratee | PropertyKey | Object): any[] | undefined;
 export declare function find(arr: any, fn: Iteratee | PropertyKey | Object): any;
 export declare function findRight(arr: any, fn: Iteratee | PropertyKey | Object): any;
@@ -168,7 +192,7 @@ export declare function lastIndexOf(obj: any, x: any, start?: any): any;
 /**
  * Creates a clone of the given `obj`. If `deep` is `true` it will clone it recursively.
  *
- * @export
+ *
  * @param {*} obj
  * @param {boolean} [deep=false]
  * @return The clone value
@@ -184,7 +208,7 @@ export declare function sortedUniq(arr: any, fn?: string | Iteratee): any[];
  *
  * Note: this method mutates `obj`
  *
- * @export
+ *
  * @param {Object} obj
  * @param {...Object} sources
  * @return {Object} The destination object.
@@ -196,7 +220,7 @@ export declare function union(...args: any[]): Generator<unknown, void, unknown>
 /**
  * Creates an object composed of keys generated from the results of running each element of `arr` thru `func`. The order of grouped values is determined by the order they occur in `arr`. The corresponding value of each key is an array of elements responsible for generating the key.
  *
- * @export
+ *
  * @param {(any[] | Object)} arr The collection to iterate over.
  * @param {(Iteratee | PropertyKey)} [func=id] The iteratee to transform keys.
  * @return {Object} Returns the composed aggregate object.