@raindrops-on-roses/number-cumulative-average 0.0.1

package/README.md

@@ -0,0 +1,33 @@
+# @raindrops-on-roses/number-cumulative-average
+
+`cumulativeAverage` utility from [raindrops-on-roses](https://www.npmjs.com/package/raindrops-on-roses).
+
+## Install
+
+```sh
+npm install @raindrops-on-roses/number-cumulative-average
+```
+
+## Usage
+
+```ts
+import { cumulativeAverage } from "@raindrops-on-roses/number-cumulative-average";
+```
+
+## With the complete library
+
+You can also install the complete library:
+
+```sh
+npm install raindrops-on-roses
+```
+
+and import the utility from the umbrella package:
+
+```ts
+import { cumulativeAverage } from "raindrops-on-roses";
+```
+
+## Repository
+
+[graphieros/raindrops-on-roses](https://github.com/graphieros/raindrops-on-roses)

package/dist/index.d.ts

@@ -0,0 +1,52 @@
+export type CumulativeAverageConfig = {
+    keepInvalid?: boolean;
+    convertInvalidToZero?: boolean;
+};
+export type CumulativeAverageParams<T = unknown> = {
+    values: T[];
+    config?: CumulativeAverageConfig;
+};
+/**
+ * Calculates the cumulative average of the provided values.
+ *
+ * ---
+ *
+ * Invalid values are values for which `Number.isFinite()` returns `false`.
+ * Depending on the configuration, they can be preserved, discarded, or
+ * treated as zero when calculating the average.
+ *
+ * @param params - The cumulative average parameters.
+ * @param params.values - The values to process.
+ * @param params.config - Options controlling how invalid values are handled.
+ * @returns An array containing the cumulative averages and, when configured,
+ * preserved invalid values.
+ *
+ * @example
+ * ```ts
+ * cumulativeAverage({
+ *     values: [1, 2, 3],
+ * }) // [1, 1.5, 2]
+ *```
+ *
+ * @example
+ * ```ts
+ * cumulativeAverage({
+ *     values: [1, null, 3],
+ *     config: { keepInvalid: true },
+ * }) // [1, null, 2]
+ *```
+ *
+ * @example
+ * ```ts
+ * cumulativeAverage({
+ *     values: [1, null, 3],
+ *     config: { keepInvalid: true, convertInvalidToZero: true },
+ * }) // [1, 0.5, 1.3333333333333333]
+ *```
+ * ---
+ *
+ * Lore:
+ * Every new experience changes ever so slightly the average that came before.
+ */
+export declare function cumulativeAverage<T = unknown>({ values, config, }: CumulativeAverageParams<T>): Array<number | T>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,CAAC,GAAG,OAAO,IAAI;IACjD,MAAM,EAAE,CAAC,EAAE,CAAC;IACZ,MAAM,CAAC,EAAE,uBAAuB,CAAC;CAClC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,GAAG,OAAO,EAAE,EAC7C,MAAM,EACN,MAAW,GACZ,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAsBhD"}

package/dist/index.js

@@ -0,0 +1,19 @@
+//#region src/index.ts
+function e({ values: e, config: t = {} }) {
+	let { keepInvalid: n = !0, convertInvalidToZero: r = !1 } = t, i = [], a = 0, o = 0;
+	for (let t of e) {
+		let e = Number.isFinite(t);
+		if (e || n) {
+			if (!e && !r) {
+				i.push(t);
+				continue;
+			}
+			a += e ? t : 0, i.push(a / ++o);
+		}
+	}
+	return i;
+}
+//#endregion
+export { e as cumulativeAverage };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export type CumulativeAverageConfig = {\n  keepInvalid?: boolean;\n  convertInvalidToZero?: boolean;\n};\n\nexport type CumulativeAverageParams<T = unknown> = {\n  values: T[];\n  config?: CumulativeAverageConfig;\n};\n\n/**\n * Calculates the cumulative average of the provided values.\n *\n * ---\n *\n * Invalid values are values for which `Number.isFinite()` returns `false`.\n * Depending on the configuration, they can be preserved, discarded, or\n * treated as zero when calculating the average.\n *\n * @param params - The cumulative average parameters.\n * @param params.values - The values to process.\n * @param params.config - Options controlling how invalid values are handled.\n * @returns An array containing the cumulative averages and, when configured,\n * preserved invalid values.\n *\n * @example\n * ```ts\n * cumulativeAverage({\n *     values: [1, 2, 3],\n * }) // [1, 1.5, 2]\n *```\n *\n * @example\n * ```ts\n * cumulativeAverage({\n *     values: [1, null, 3],\n *     config: { keepInvalid: true },\n * }) // [1, null, 2]\n *```\n *\n * @example\n * ```ts\n * cumulativeAverage({\n *     values: [1, null, 3],\n *     config: { keepInvalid: true, convertInvalidToZero: true },\n * }) // [1, 0.5, 1.3333333333333333]\n *```\n * ---\n *\n * Lore:\n * Every new experience changes ever so slightly the average that came before.\n */\nexport function cumulativeAverage<T = unknown>({\n  values,\n  config = {},\n}: CumulativeAverageParams<T>): Array<number | T> {\n  const { keepInvalid = true, convertInvalidToZero = false } = config;\n\n  const result: Array<number | T> = [];\n  let sum = 0;\n  let count = 0;\n\n  for (const value of values) {\n    const valid = Number.isFinite(value);\n\n    if (!valid && !keepInvalid) continue;\n\n    if (!valid && !convertInvalidToZero) {\n      result.push(value);\n      continue;\n    }\n\n    sum += valid ? (value as number) : 0;\n    result.push(sum / ++count);\n  }\n\n  return result;\n}\n"],"mappings":";AAoDA,SAAgB,EAA+B,EAC7C,WACA,YAAS,CAAC,KACsC;CAChD,IAAM,EAAE,iBAAc,IAAM,0BAAuB,OAAU,GAEvD,IAA4B,CAAC,GAC/B,IAAM,GACN,IAAQ;CAEZ,KAAK,IAAM,KAAS,GAAQ;EAC1B,IAAM,IAAQ,OAAO,SAAS,CAAK;EAE/B,IAAC,KAAU,GAEf;OAAI,CAAC,KAAS,CAAC,GAAsB;IACnC,EAAO,KAAK,CAAK;IACjB;GACF;GAGA,AADA,KAAO,IAAS,IAAmB,GACnC,EAAO,KAAK,IAAM,EAAE,CAAK;EAHzB;CAIF;CAEA,OAAO;AACT"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@raindrops-on-roses/number-cumulative-average",
+  "version": "0.0.1",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "homepage": "https://raindrops-on-roses.graphieros.com/number/cumulative-average",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/graphieros/raindrops-on-roses.git",
+    "directory": "packages/number-cumulative-average"
+  }
+}