synstate-react-hooks 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,6 +4,8 @@ synstate-react-hooks re-exports all exports from synstate except for `createStat
4
4
 
5
5
  The first element of the array returned by the `createState<T>` function provided by synstate-react-hooks is changed from `InitializedObservable<T>` to a React hook `() => T`, and the `InitializedObservable<T>` has been moved to the `state` property in the object at index 2.
6
6
 
7
+ Their options, such as `equals` (the second argument of `createState` and `createBooleanState`, the third of `createReducer`), are passed to synstate as they are.
8
+
7
9
  ## Installation
8
10
 
9
11
  ```bash
@@ -1,5 +1,4 @@
1
- import type { InitializedObservable, Observable } from 'synstate';
1
+ import type { InitializedObservable, Observable, ObservableValue } from 'synstate';
2
2
  export declare function useObservableValue<A, B = A>(observable$: Observable<A>, initialValue: B): A | B;
3
- export declare function useObservableValue<A>(observable$: InitializedObservable<A>): A;
4
- export declare function useObservableValue<A>(observable$: Observable<A>): A | undefined;
3
+ export declare function useObservableValue<O extends Observable<unknown>>(observable$: O): O extends InitializedObservable<infer A> ? A : ObservableValue<O> | undefined;
5
4
  //# sourceMappingURL=use-observable-value.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"use-observable-value.d.mts","sourceRoot":"","sources":["../src/use-observable-value.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGlE,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EACzC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,EAC1B,YAAY,EAAE,CAAC,GACd,CAAC,GAAG,CAAC,CAAC;AAET,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,WAAW,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAEhF,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,GACzB,CAAC,GAAG,SAAS,CAAC"}
1
+ {"version":3,"file":"use-observable-value.d.mts","sourceRoot":"","sources":["../src/use-observable-value.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,qBAAqB,EACrB,UAAU,EACV,eAAe,EAChB,MAAM,UAAU,CAAC;AAGlB,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EACzC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,EAC1B,YAAY,EAAE,CAAC,GACd,CAAC,GAAG,CAAC,CAAC;AAET,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,UAAU,CAAC,OAAO,CAAC,EAC9D,WAAW,EAAE,CAAC,GACb,CAAC,SAAS,qBAAqB,CAAC,MAAM,CAAC,CAAC,GACvC,CAAC,GACD,eAAe,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"use-observable-value.mjs","sourceRoot":"","sources":["../src/use-observable-value.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAazC,MAAM,UAAU,kBAAkB,CAChC,WAA0B,EAC1B,YAAgB;IAEhB,MAAM,KAAK,GAAG,KAAK,CAAC,oBAAoB,CACtC,CAAC,aAAyB,EAAE,EAAE;QAC5B,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC,EACD,GAAG,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,CAChC,CAAC;IAEF,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AAChD,CAAC"}
1
+ {"version":3,"file":"use-observable-value.mjs","sourceRoot":"","sources":["../src/use-observable-value.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAM/B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAazC,MAAM,UAAU,kBAAkB,CAChC,WAA0B,EAC1B,YAAgB;IAEhB,MAAM,KAAK,GAAG,KAAK,CAAC,oBAAoB,CACtC,CAAC,aAAyB,EAAE,EAAE;QAC5B,MAAM,EAAE,WAAW,EAAE,GAAG,WAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAE7D,OAAO,WAAW,CAAC;IACrB,CAAC,EACD,GAAG,EAAE,CAAC,WAAW,CAAC,WAAW,EAAE,CAChC,CAAC;IAEF,OAAO,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AAChD,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "synstate-react-hooks",
3
- "version": "3.1.0",
3
+ "version": "3.2.0",
4
4
  "description": "Type-safe State Management Library for TypeScript/JavaScript",
5
5
  "repository": {
6
6
  "type": "git",
@@ -28,7 +28,7 @@
28
28
  "LICENSE"
29
29
  ],
30
30
  "dependencies": {
31
- "synstate": "3.1.0",
31
+ "synstate": "3.2.0",
32
32
  "ts-data-forge": "^14.7.1",
33
33
  "ts-type-forge": "^9.2.2"
34
34
  },
@@ -38,11 +38,11 @@
38
38
  "@testing-library/react": "16.3.3",
39
39
  "@types/react": "19.3.0",
40
40
  "@types/react-dom": "19.3.0",
41
- "@vitest/browser-playwright": "5.0.2",
42
- "eslint-config-typed": "5.17.0",
43
- "eslint-plugin-ts-data-forge": "0.8.3",
44
- "eslint-plugin-ts-fortress": "1.3.0",
45
- "eslint-plugin-ts-type-forge": "0.8.5",
41
+ "@vitest/browser-playwright": "5.0.3",
42
+ "eslint-config-typed": "5.17.1",
43
+ "eslint-plugin-ts-data-forge": "0.8.4",
44
+ "eslint-plugin-ts-fortress": "1.3.1",
45
+ "eslint-plugin-ts-type-forge": "0.8.6",
46
46
  "playwright": "1.63.0",
47
47
  "prettier": "3.9.9",
48
48
  "prettier-plugin-organize-imports": "4.3.0",
@@ -1,5 +1,9 @@
1
1
  import * as React from 'react';
2
- import type { InitializedObservable, Observable } from 'synstate';
2
+ import type {
3
+ InitializedObservable,
4
+ Observable,
5
+ ObservableValue,
6
+ } from 'synstate';
3
7
  import { Optional } from 'ts-data-forge';
4
8
 
5
9
  export function useObservableValue<A, B = A>(
@@ -7,11 +11,11 @@ export function useObservableValue<A, B = A>(
7
11
  initialValue: B,
8
12
  ): A | B;
9
13
 
10
- export function useObservableValue<A>(observable$: InitializedObservable<A>): A;
11
-
12
- export function useObservableValue<A>(
13
- observable$: Observable<A>,
14
- ): A | undefined;
14
+ export function useObservableValue<O extends Observable<unknown>>(
15
+ observable$: O,
16
+ ): O extends InitializedObservable<infer A>
17
+ ? A
18
+ : ObservableValue<O> | undefined;
15
19
 
16
20
  export function useObservableValue<A, B = A>(
17
21
  observable$: Observable<A>,