@helpers4/observable 2.0.0-alpha.7 → 2.0.0-alpha.8

package/lib/index.d.ts

@@ -23,6 +23,7 @@ type combineOptions<T, U> = {
  * @returns an observable that emits the result of the map function
  * @see combineLatestOperator
  * @see mapOperator
+ * @since 1.0.0
  */
 declare function combine<T, U, R>(source1: Observable<T>, source2: Observable<U>, map: (c: readonly [T, U]) => R, options?: combineOptions<T, U>): Observable<R>;
 

package/lib/index.js

@@ -19,6 +19,7 @@ import { combineLatest as combineLatest$1, map, of } from "rxjs";
 * @returns an observable that emits the result of the map function
 * @see combineLatestOperator
 * @see mapOperator
+* @since 1.0.0
 */
 function combine(source1, source2, map$1, options) {
 	if (options?.preTreatment) return combineLatest$1([source1, source2]).pipe(options.preTreatment, map(map$1));
@@ -54,6 +55,7 @@ function combine(source1, source2, map$1, options) {
 * @returns {Observable} An Observable of projected values from the most recent
 * values from each input Observable, or an array of the most recent values from
 * each input Observable.
+* @since 1.0.0
 */
 function combineLatest(input) {
 	if (Array.isArray(input)) {

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/observable/combine.ts","../../../helpers/observable/combineLatest.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/*\n * This program is under the terms of the GNU Lesser General Public License version 3\n * The full license information can be found in LICENSE in the root directory of this project.\n */\nimport {\n  Observable,\n  OperatorFunction,\n  combineLatest as combineLatestOperator,\n  map as mapOperator,\n} from \"rxjs\";\n\n\ntype combineOptions<T, U> = {\n  readonly preTreatment?: OperatorFunction<readonly [T, U], readonly [T, U]>;\n};\n\n/**\n * Combine two observables with a map function and an optional pre-treatment.\n *\n * Note: you can use the pre-treatment to add a filter, a distinctUntilChanged,\n * any other operator that can be used in a pipe, or even an `UntilDestroy`\n * operator.\n *\n * @param source1 first source of data\n * @param source2 second source of data\n * @param map way to combine data\n * @param options options for the combineLatest operator\n * @returns an observable that emits the result of the map function\n * @see combineLatestOperator\n * @see mapOperator\n */\nexport function combine<T, U, R>(\n  source1: Observable<T>,\n  source2: Observable<U>,\n  map: (c: readonly [T, U]) => R,\n  options?: combineOptions<T, U>\n): Observable<R> {\n  if (options?.preTreatment) {\n    return combineLatestOperator([source1, source2]).pipe(\n      options.preTreatment,\n      mapOperator(map)\n    );\n  } else {\n    return combineLatestOperator([source1, source2]).pipe(mapOperator(map));\n  }\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/*\n * This program is under the terms of the GNU Lesser General Public License version 3\n * The full license information can be found in LICENSE in the root directory of this project.\n */\nimport {\n  Observable,\n  ObservableInput,\n  ObservableInputTuple,\n  ObservedValueOf,\n  combineLatest as combineLatestOperator,\n  of,\n} from \"rxjs\";\n\n// combineLatest([a, b, c])\nexport function combineLatest<A extends readonly unknown[]>(\n  sources: readonly [...ObservableInputTuple<A>]\n): Observable<A>;\n\n// combineLatest({a, b, c})\nexport function combineLatest<T extends Record<string, ObservableInput<any>>>(\n  sourcesObject: T\n): Observable<{ [K in keyof T]: ObservedValueOf<T[K]> }>;\n\n/**\n * Combines multiple Observables to create an Observable whose values are\n * calculated from the latest values of each of its input Observables.\n *\n * This method relies on {@link combineLatestOperator} of rxjs.\n *\n * The main difference with {@link combineLatestOperator} is in case of empty parameters.\n * If the parameter is empty (empty array or empty object), the result will be\n * also empty.\n *\n * ATTENTION: this version doesn't support `scheduler` nor `mapper` as last\n * argument like in {@link combineLatestOperator}.\n *\n * @see {@link combineLatestOperator}\n * @see {@link combineLatestAll}\n * @see {@link merge}\n * @see {@link withLatestFrom}\n *\n * @param {ObservableInput} [observables] An array of input Observables to combine with each other.\n * An array of Observables must be given as the first argument.\n * @returns {Observable} An Observable of projected values from the most recent\n * values from each input Observable, or an array of the most recent values from\n * each input Observable.\n */\nexport function combineLatest(input: any): any {\n  if (Array.isArray(input)) {\n    input = input.filter((a) => !!a);\n    return input.length ? combineLatestOperator(...input) : of([]);\n  } else {\n    return Object.entries(input).filter(([_, v]) => !!v).length\n      ? combineLatestOperator(input)\n      : of({});\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAqCA,SAAgB,QACd,SACA,SACA,OACA,SACe;AACf,KAAI,SAAS,aACX,QAAO,gBAAsB,CAAC,SAAS,QAAQ,CAAC,CAAC,KAC/C,QAAQ,cACR,IAAY,MAAI,CACjB;KAED,QAAO,gBAAsB,CAAC,SAAS,QAAQ,CAAC,CAAC,KAAK,IAAY,MAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACI3E,SAAgB,cAAc,OAAiB;AAC7C,KAAI,MAAM,QAAQ,MAAM,EAAE;AACxB,UAAQ,MAAM,QAAQ,MAAM,CAAC,CAAC,EAAE;AAChC,SAAO,MAAM,SAAS,gBAAsB,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC;OAE9D,QAAO,OAAO,QAAQ,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,SACjD,gBAAsB,MAAM,GAC5B,GAAG,EAAE,CAAC"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/observable/combine.ts","../../../helpers/observable/combineLatest.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/*\n * This program is under the terms of the GNU Lesser General Public License version 3\n * The full license information can be found in LICENSE in the root directory of this project.\n */\nimport {\n  Observable,\n  OperatorFunction,\n  combineLatest as combineLatestOperator,\n  map as mapOperator,\n} from \"rxjs\";\n\n\ntype combineOptions<T, U> = {\n  readonly preTreatment?: OperatorFunction<readonly [T, U], readonly [T, U]>;\n};\n\n/**\n * Combine two observables with a map function and an optional pre-treatment.\n *\n * Note: you can use the pre-treatment to add a filter, a distinctUntilChanged,\n * any other operator that can be used in a pipe, or even an `UntilDestroy`\n * operator.\n *\n * @param source1 first source of data\n * @param source2 second source of data\n * @param map way to combine data\n * @param options options for the combineLatest operator\n * @returns an observable that emits the result of the map function\n * @see combineLatestOperator\n * @see mapOperator\n * @since 1.0.0\n */\nexport function combine<T, U, R>(\n  source1: Observable<T>,\n  source2: Observable<U>,\n  map: (c: readonly [T, U]) => R,\n  options?: combineOptions<T, U>\n): Observable<R> {\n  if (options?.preTreatment) {\n    return combineLatestOperator([source1, source2]).pipe(\n      options.preTreatment,\n      mapOperator(map)\n    );\n  } else {\n    return combineLatestOperator([source1, source2]).pipe(mapOperator(map));\n  }\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/*\n * This program is under the terms of the GNU Lesser General Public License version 3\n * The full license information can be found in LICENSE in the root directory of this project.\n */\nimport {\n  Observable,\n  ObservableInput,\n  ObservableInputTuple,\n  ObservedValueOf,\n  combineLatest as combineLatestOperator,\n  of,\n} from \"rxjs\";\n\n// combineLatest([a, b, c])\nexport function combineLatest<A extends readonly unknown[]>(\n  sources: readonly [...ObservableInputTuple<A>]\n): Observable<A>;\n\n// combineLatest({a, b, c})\nexport function combineLatest<T extends Record<string, ObservableInput<any>>>(\n  sourcesObject: T\n): Observable<{ [K in keyof T]: ObservedValueOf<T[K]> }>;\n\n/**\n * Combines multiple Observables to create an Observable whose values are\n * calculated from the latest values of each of its input Observables.\n *\n * This method relies on {@link combineLatestOperator} of rxjs.\n *\n * The main difference with {@link combineLatestOperator} is in case of empty parameters.\n * If the parameter is empty (empty array or empty object), the result will be\n * also empty.\n *\n * ATTENTION: this version doesn't support `scheduler` nor `mapper` as last\n * argument like in {@link combineLatestOperator}.\n *\n * @see {@link combineLatestOperator}\n * @see {@link combineLatestAll}\n * @see {@link merge}\n * @see {@link withLatestFrom}\n *\n * @param {ObservableInput} [observables] An array of input Observables to combine with each other.\n * An array of Observables must be given as the first argument.\n * @returns {Observable} An Observable of projected values from the most recent\n * values from each input Observable, or an array of the most recent values from\n * each input Observable.\n * @since 1.0.0\n */\nexport function combineLatest(input: any): any {\n  if (Array.isArray(input)) {\n    input = input.filter((a) => !!a);\n    return input.length ? combineLatestOperator(...input) : of([]);\n  } else {\n    return Object.entries(input).filter(([_, v]) => !!v).length\n      ? combineLatestOperator(input)\n      : of({});\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAsCA,SAAgB,QACd,SACA,SACA,OACA,SACe;AACf,KAAI,SAAS,aACX,QAAO,gBAAsB,CAAC,SAAS,QAAQ,CAAC,CAAC,KAC/C,QAAQ,cACR,IAAY,MAAI,CACjB;KAED,QAAO,gBAAsB,CAAC,SAAS,QAAQ,CAAC,CAAC,KAAK,IAAY,MAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACI3E,SAAgB,cAAc,OAAiB;AAC7C,KAAI,MAAM,QAAQ,MAAM,EAAE;AACxB,UAAQ,MAAM,QAAQ,MAAM,CAAC,CAAC,EAAE;AAChC,SAAO,MAAM,SAAS,gBAAsB,GAAG,MAAM,GAAG,GAAG,EAAE,CAAC;OAE9D,QAAO,OAAO,QAAQ,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,SACjD,gBAAsB,MAAM,GAC5B,GAAG,EAAE,CAAC"}

package/meta/api.json

@@ -0,0 +1,127 @@
+{
+  "category": "observable",
+  "version": "2.0.0-alpha.8",
+  "functions": [
+    {
+      "name": "combine",
+      "kind": "function",
+      "description": "Combine two observables with a map function and an optional pre-treatment.\n\nNote: you can use the pre-treatment to add a filter, a distinctUntilChanged,\nany other operator that can be used in a pipe, or even an `UntilDestroy`\noperator.",
+      "since": "1.0.0",
+      "signatures": [
+        {
+          "signature": "combine<T, U, R>(source1: Observable<T>, source2: Observable<U>, map: function, options?: combineOptions<T, U>): Observable<R>",
+          "description": "Combine two observables with a map function and an optional pre-treatment.\n\nNote: you can use the pre-treatment to add a filter, a distinctUntilChanged,\nany other operator that can be used in a pipe, or even an `UntilDestroy`\noperator.",
+          "params": [
+            {
+              "name": "source1",
+              "type": "Observable<T>",
+              "description": "first source of data"
+            },
+            {
+              "name": "source2",
+              "type": "Observable<U>",
+              "description": "second source of data"
+            },
+            {
+              "name": "map",
+              "type": "function",
+              "description": "way to combine data"
+            },
+            {
+              "name": "options",
+              "type": "combineOptions<T, U>",
+              "description": "options for the combineLatest operator",
+              "optional": true
+            }
+          ],
+          "returns": {
+            "type": "Observable<R>",
+            "description": "an observable that emits the result of the map function"
+          },
+          "typeParameters": [
+            {
+              "name": "T"
+            },
+            {
+              "name": "U"
+            },
+            {
+              "name": "R"
+            }
+          ]
+        }
+      ],
+      "examples": [
+        {
+          "title": "Combine two observables with a map",
+          "description": "Combines the latest values of two observables using a mapping function.",
+          "code": "combine(of(1), of(2), ([a, b]) => a + b)\n// emits 3"
+        }
+      ],
+      "sourceFile": "combine.ts"
+    },
+    {
+      "name": "combineLatest",
+      "kind": "function",
+      "description": "Combines multiple Observables to create an Observable whose values are\ncalculated from the latest values of each of its input Observables.\n\nThis method relies on combineLatestOperator of rxjs.\n\nThe main difference with combineLatestOperator is in case of empty parameters.\nIf the parameter is empty (empty array or empty object), the result will be\nalso empty.\n\nATTENTION: this version doesn't support `scheduler` nor `mapper` as last\nargument like in combineLatestOperator.",
+      "since": "1.0.0",
+      "signatures": [
+        {
+          "signature": "combineLatest<A extends readonly unknown[]>(sources: readonly [ObservableInputTuple<A>]): Observable<A>",
+          "description": "",
+          "params": [
+            {
+              "name": "sources",
+              "type": "readonly [ObservableInputTuple<A>]",
+              "description": ""
+            }
+          ],
+          "returns": {
+            "type": "Observable<A>",
+            "description": ""
+          },
+          "typeParameters": [
+            {
+              "name": "A",
+              "constraint": "readonly unknown[]"
+            }
+          ]
+        },
+        {
+          "signature": "combineLatest<T extends Record<string, ObservableInput<any>>>(sourcesObject: T): Observable<mapped>",
+          "description": "",
+          "params": [
+            {
+              "name": "sourcesObject",
+              "type": "T",
+              "description": ""
+            }
+          ],
+          "returns": {
+            "type": "Observable<mapped>",
+            "description": ""
+          },
+          "typeParameters": [
+            {
+              "name": "T",
+              "constraint": "Record<string, ObservableInput<any>>"
+            }
+          ]
+        }
+      ],
+      "examples": [
+        {
+          "title": "Combine array of observables",
+          "description": "Combines an array of observables into one that emits arrays of their latest values.",
+          "code": "combineLatest([of(1), of(2), of(3)])\n// emits [1, 2, 3]"
+        },
+        {
+          "title": "Handle empty array",
+          "description": "Returns an observable that emits an empty array when given no sources.",
+          "code": "combineLatest([])\n// emits []"
+        }
+      ],
+      "sourceFile": "combineLatest.ts"
+    }
+  ]
+}

package/{examples.json → meta/examples.json}

@@ -1,8 +1,8 @@
 {
   "category": "observable",
-  "helpers": [
+  "functions": [
     {
-      "helper": "combine",
+      "name": "combine",
       "examples": [
         {
           "title": "Combine two observables with a map",
@@ -12,7 +12,7 @@
       ]
     },
     {
-      "helper": "combineLatest",
+      "name": "combineLatest",
       "examples": [
         {
           "title": "Combine array of observables",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpers4/observable",
-  "version": "2.0.0-alpha.7",
+  "version": "2.0.0-alpha.8",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for observable.",
   "author": "baxyz <baxy@etik.com>",
   "license": "LGPL-3.0",
@@ -17,9 +17,9 @@
       "types": "./lib/index.d.ts",
       "import": "./lib/index.js"
     },
-    "./examples.json": "./examples.json",
-    "./api.json": "./api.json",
-    "./licenses.json": "./licenses.json",
+    "./meta/api.json": "./meta/api.json",
+    "./meta/examples.json": "./meta/examples.json",
+    "./meta/licenses.json": "./meta/licenses.json",
     "./package.json": "./package.json"
   },
   "keywords": [
@@ -32,9 +32,7 @@
     "lib/index.js",
     "lib/index.d.ts",
     "lib/index.js.map",
-    "examples.json",
-    "api.json",
-    "licenses.json",
+    "meta/",
     "LICENSE.md",
     "package.json",
     "README.md"
@@ -45,4 +43,4 @@
   "peerDependencies": {
     "rxjs": "^7.8.2"
   }
-}
+}

package/api.json

@@ -1,48 +0,0 @@
-{
-  "category": "observable",
-  "members": [
-    {
-      "name": "combine",
-      "kind": "function",
-      "description": "Combine two observables with a map function and an optional pre-treatment.\n\nNote: you can use the pre-treatment to add a filter, a distinctUntilChanged,\nany other operator that can be used in a pipe, or even an `UntilDestroy`\noperator.",
-      "signature": "combine<T, U, R>(source1: Observable<T>, source2: Observable<U>, map: object, options: combineOptions<T, U>): Observable<R>",
-      "params": [
-        {
-          "name": "source1",
-          "type": "Observable<T>",
-          "description": "first source of data"
-        },
-        {
-          "name": "source2",
-          "type": "Observable<U>",
-          "description": "second source of data"
-        },
-        {
-          "name": "map",
-          "type": "object",
-          "description": "way to combine data"
-        },
-        {
-          "name": "options",
-          "type": "combineOptions<T, U>",
-          "description": "options for the combineLatest operator"
-        }
-      ],
-      "returns": "Observable<R>"
-    },
-    {
-      "name": "combineLatest",
-      "kind": "function",
-      "description": "Combines multiple Observables to create an Observable whose values are\ncalculated from the latest values of each of its input Observables.\n\nThis method relies on combineLatestOperator of rxjs.\n\nThe main difference with combineLatestOperator is in case of empty parameters.\nIf the parameter is empty (empty array or empty object), the result will be\nalso empty.\n\nATTENTION: this version doesn't support `scheduler` nor `mapper` as last\nargument like in combineLatestOperator.",
-      "signature": "combineLatest<A>(sources: typeOperator): Observable<A>",
-      "params": [
-        {
-          "name": "sources",
-          "type": "typeOperator",
-          "description": ""
-        }
-      ],
-      "returns": "Observable<A>"
-    }
-  ]
-}