fix(signals): allow using signalStore and signalState in TS libs #4152
Conversation
✅ Deploy Preview for ngrx-io canceled.
|
| Prettify< | ||
| SignalStoreSlices<FeatureResult['state']> & | ||
| FeatureResult['signals'] & | ||
| FeatureResult['methods'] & | ||
| SignalStateMeta<Prettify<FeatureResult['state']>> | ||
| FeatureResult['methods'] |
There was a problem hiding this comment.
A workaround for this TS bug is to always put a unique symbol inside of the named type.
Before:
The STATE_SIGNAL was appended to the dynamic SignalStore type by prettifying the intersection.
const CounterStore = signalStore(withState({ count: 0 }));
// type: Type<{ count: Signal<number>; [STATE_SIGNAL]: WritableSignal<{ count: number }> }>After:
The STATE_SIGNAL is always exported as a part of the StateSignal type.
const CounterStore = signalStore(withState({ count: 0 }));
// type: Type<{ count: Signal<number>; } & StateSignal<{ count: number }>>
There was a problem hiding this comment.
Makes sense.
StateSignal has to be added to the public APIs index.ts as well, right?
There was a problem hiding this comment.
It's not needed. We can keep it private.
| @@ -8,7 +8,7 @@ import { IsKnownRecord } from './ts-helpers'; | |||
|
|
|||
| // An extended Signal type that enables the correct typing | |||
| // of nested signals with the `name` or `length` key. | |||
| interface Signal<T> extends NgSignal<T> { | |||
| export interface Signal<T> extends NgSignal<T> { | |||
There was a problem hiding this comment.
This export fixes the same compilation error in TS libraries with declaration: true when signalState is used. The problem was caused by another unique symbol - Angular's SIGNAL.
|
Please, somebody approve it) |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Closes #4151
What is the new behavior?
signalStoreandsignalStatecan be used/exported in projects that havetsconfigwith"declaration": true.Does this PR introduce a breaking change?
Other information
This is a workaround for the following TS bug: microsoft/TypeScript#37888