feat: renamed usePushObservable to useControllableObservable, added ControllableObservable type

Author: Duke

src/index.ts

@@ -821,7 +821,7 @@ export function createFamily<K, P>(
   return fn as Family<K, P>
 }
 
-export { createOperator, operators, pipe, type Subscribable, observables } from './rx'
+export { createOperator, operators, pipe, type Subscribable, type ControllableObservable, observables } from './rx'
 
 export type PushObservableExecutor<Value> = Executor<PushObservable<Value>>
 

src/react/index.tsx

@@ -7,8 +7,8 @@ import {
 	type Executor,
 	type Scope,
 	type Subscribable,
+	type ControllableObservable,
 	observables,
-	type OperatorLike,
 	pipe,
 } from "../";
 
@@ -199,10 +199,12 @@ const NOT_EMITTED = {
 /**
  * @param pobservable - The push observable executor to use.
  * @returns A tuple containing the emission and a subscriber for the push observable.
+ * - left is the emission of the observable.
+ * - right is the controller (or subscriber)
  */
-export function usePushObservable<P>(
-	pobservable: PushObservableExecutor<P>,
-): [Emission<P> & Result<P>, Subscriber<P>] {
+export function useControllableObservable<P, V>(
+	pobservable: Executor<ControllableObservable<P, V>>,
+): [Emission<P> & Result<P>, V] {
 	const [observable, subscriber] = useResolve(pobservable);
 
 	return [useObservableValue(observable), subscriber];

src/rx.ts

@@ -69,11 +69,14 @@ export type Subscriber<T> = {
   complete: () => void
 }
 
+/** Utility type to force tuple Subscriber and controller */
+export type ControllableObservable<T, V> = [Subscribable<T>, V]
+
 /**
  * Represents a push-based observable with a subscriber.
  * @template T The type of the value emitted by the observable.
  */
-export type PushObservable<T> = [Subscribable<T>, Subscriber<T>];
+export type PushObservable<T> = ControllableObservable<T, Subscriber<T>>
 
 type SubjectInit<T> = {
   kind: 'init'

tests/react/index.test.tsx

@@ -10,7 +10,7 @@ import {
 import {
 	ScopeProvider,
 	useObservable,
-	usePushObservable,
+	useControllableObservable,
 	useResolve,
 } from "../../src/react";
 import type { PropsWithChildren } from "react";
@@ -60,7 +60,8 @@ describe("test observable", () => {
 	test("manual observable should just work", async () => {
 		const { result } = renderHook(
 			() => {
-				const [counter, setCounter] = usePushObservable(observableCount);
+				const [counter, setCounter] =
+					useControllableObservable(observableCount);
 
 				return { counter, setCounter };
 			},
@@ -89,8 +90,9 @@ describe("test observable", () => {
 	test("useObservable with a little bit more complicated usecase", async () => {
 		const { result } = renderHook(
 			() => {
-				const [selectedId, setSelectedId] = usePushObservable(selectedIdStream);
-				const [list, setList] = usePushObservable(listStream);
+				const [selectedId, setSelectedId] =
+					useControllableObservable(selectedIdStream);
+				const [list, setList] = useControllableObservable(listStream);
 				const selected = useObservable(selectedItem);
 
 				return {
@@ -173,7 +175,8 @@ describe("test useOperator with useObservable and useObservableValue", () => {
 		const { result } = renderHook(
 			() => {
 				const [factor, setFactor] = useState(1);
-				const [counter, setCounter] = usePushObservable(observableCount);
+				const [counter, setCounter] =
+					useControllableObservable(observableCount);
 				const doubledCounter = useObservable(observableCount, operator);
 
 				return { counter, setCounter, doubledCounter, factor, setFactor };
@@ -217,7 +220,8 @@ describe("test useOperator with useObservable and useObservableValue", () => {
 					[],
 				);
 
-				const [counter, setCounter] = usePushObservable(observableCount);
+				const [counter, setCounter] =
+					useControllableObservable(observableCount);
 				const doubledCounter = useObservable(
 					observableCount,
 					operator,