feat: Renamed StoreOptions.stateComparator to `StoreOptions.compara…

…tor`
mnasyrov · Nov 7, 2022 · 11442f6 · 11442f6
1 parent d22b264
commit 11442f6
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/packages/rx-effects/src/store.test.ts b/packages/rx-effects/src/store.test.ts
@@ -17,7 +17,7 @@ describe('Store', () => {
     it('should use a custom "stateCompare" predicate', async () => {
       const store = createStore<State>(
         { value: 1, data: 'a' },
-        { stateComparator: (s1, s2) => s1.value === s2.value },
+        { comparator: (s1, s2) => s1.value === s2.value },
       );
 
       const changes = await collectChanges(store.value$, () => {
@@ -308,7 +308,7 @@ function createTestStore<State>(
   const patch =
     (partial: Partial<State>) =>
     (state: State): State => ({ ...state, ...partial });
-  const store = createStore(initialState, { stateComparator: comparator });
+  const store = createStore(initialState, { comparator: comparator });
 
   const history: State[] = [];
   store.value$.subscribe((state) => history.push(state));

diff --git a/packages/rx-effects/src/store.ts b/packages/rx-effects/src/store.ts
@@ -77,7 +77,7 @@ export type StoreOptions<State> = Readonly<{
   name?: string;
 
   /** A comparator for detecting changes between old and new states */
-  stateComparator?: (prevState: State, nextState: State) => boolean;
+  comparator?: (prevState: State, nextState: State) => boolean;
 
   /** @internal */
   internal?: boolean;
@@ -93,7 +93,7 @@ export function createStore<State>(
   initialState: State,
   options?: StoreOptions<State>,
 ): Store<State> {
-  const stateComparator = options?.stateComparator ?? DEFAULT_COMPARATOR;
+  const stateComparator = options?.comparator ?? DEFAULT_COMPARATOR;
 
   const store$: BehaviorSubject<State> = new BehaviorSubject(initialState);
   const state$ = store$.asObservable();