@helpers4/observable 2.0.0-alpha.2 → 2.0.0-alpha.6

package/README.md

@@ -22,6 +22,7 @@ A set of helpers for working with URLs.
 - [array](../array)
 - [date](../date)
 - [function](../function)
+- [math](../math)
 - [number](../number)
 - [object](../object)
 - [promise](../promise)
@@ -39,6 +40,7 @@ A set of helpers for working with URLs.
 | array | [@helpers4/array](https://www.npmjs.com/package/@helpers4/array) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/array) | Array manipulation utilities |
 | date | [@helpers4/date](https://www.npmjs.com/package/@helpers4/date) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/date) | date utilities |
 | function | [@helpers4/function](https://www.npmjs.com/package/@helpers4/function) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/function) | Function utilities and type guards |
+| math | [@helpers4/math](https://www.npmjs.com/package/@helpers4/math) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/math) | math utilities |
 | number | [@helpers4/number](https://www.npmjs.com/package/@helpers4/number) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/number) | number utilities |
 | object | [@helpers4/object](https://www.npmjs.com/package/@helpers4/object) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/object) | Object manipulation utilities |
 | observable | [@helpers4/observable](https://www.npmjs.com/package/@helpers4/observable) | [Source](https://github.com/helpers4/helpers4/tree/main/helpers/observable) | Observable utilities and combinators |

package/api.json

@@ -0,0 +1,48 @@
+{
+  "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>"
+    }
+  ]
+}

package/examples.json

@@ -0,0 +1,30 @@
+{
+  "category": "observable",
+  "helpers": [
+    {
+      "helper": "combine",
+      "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"
+        }
+      ]
+    },
+    {
+      "helper": "combineLatest",
+      "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 []"
+        }
+      ]
+    }
+  ]
+}

package/lib/index.d.ts

@@ -1,4 +1,40 @@
-export declare function combine<T, U, R>(source1: Observable<T>, source2: Observable<U>, map: (c: readonly [T, U]);
-export declare function combineLatest<A extends readonly unknown[]>(sources: readonly [...ObservableInputTuple<A>]): Observable<A>;  // combineLatest(;
-export declare function combineLatest<T extends Record<string, ObservableInput<any>>>(sourcesObject: T): Observable<;
-export declare function combineLatest(input: any): any;
+import { Observable, OperatorFunction, ObservableInputTuple, ObservableInput, ObservedValueOf } from 'rxjs';
+
+/**
+ * This file is part of helpers4.
+ * Copyright (C) 2025 baxyz
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+type combineOptions<T, U> = {
+    readonly preTreatment?: OperatorFunction<readonly [T, U], readonly [T, U]>;
+};
+/**
+ * Combine two observables with a map function and an optional pre-treatment.
+ *
+ * Note: you can use the pre-treatment to add a filter, a distinctUntilChanged,
+ * any other operator that can be used in a pipe, or even an `UntilDestroy`
+ * operator.
+ *
+ * @param source1 first source of data
+ * @param source2 second source of data
+ * @param map way to combine data
+ * @param options options for the combineLatest operator
+ * @returns an observable that emits the result of the map function
+ * @see combineLatestOperator
+ * @see mapOperator
+ */
+declare function combine<T, U, R>(source1: Observable<T>, source2: Observable<U>, map: (c: readonly [T, U]) => R, options?: combineOptions<T, U>): Observable<R>;
+
+/**
+ * This file is part of helpers4.
+ * Copyright (C) 2025 baxyz
+ * SPDX-License-Identifier: LGPL-3.0-or-later
+ */
+
+declare function combineLatest<A extends readonly unknown[]>(sources: readonly [...ObservableInputTuple<A>]): Observable<A>;
+declare function combineLatest<T extends Record<string, ObservableInput<any>>>(sourcesObject: T): Observable<{
+    [K in keyof T]: ObservedValueOf<T[K]>;
+}>;
+
+export { combine, combineLatest };