feat(store): rename getMockStore to createMockStore (#3789)

Closes #3781
ngrx · Feb 28, 2023 · 6d615b3 · 6d615b3
1 parent 9b3647f
commit 6d615b3
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 10 deletions.
diff --git a/modules/store/testing/spec/mock_store.spec.ts b/modules/store/testing/spec/mock_store.spec.ts
@@ -1,7 +1,7 @@
 import { TestBed, ComponentFixture } from '@angular/core/testing';
 import { skip, take } from 'rxjs/operators';
 import {
-  getMockStore,
+  createMockStore,
   MockReducerManager,
   MockState,
   MockStore,
@@ -410,11 +410,11 @@ describe('Mock Store with Injector', () => {
     });
   });
 
-  describe('getMockStore', () => {
+  describe('createMockStore', () => {
     let mockStore: MockStore<typeof initialState>;
 
     beforeEach(() => {
-      mockStore = getMockStore({ initialState, selectors: [mockSelector] });
+      mockStore = createMockStore({ initialState, selectors: [mockSelector] });
     });
 
     it('should create MockStore', (done: any) => {

diff --git a/modules/store/testing/src/testing.ts b/modules/store/testing/src/testing.ts
@@ -126,6 +126,14 @@ function mockStoreFactory<T>(
   );
 }
 
+/**
+ * @deprecated This function is deprecated in favor of `createMockStore`.
+ * If you are looking to get an existing mock store, you probably want to use `TestBed.inject(MockStore)` instead.
+ *
+ * For more info see: https://github.com/ngrx/platform/issues/3781
+ */
+export const getMockStore = createMockStore;
+
 /**
  * @description
  * Creates mock store with all necessary dependencies outside of the `TestBed`.
@@ -141,7 +149,7 @@ function mockStoreFactory<T>(
  *   let store: MockStore;
  *
  *   beforeEach(() => {
- *     store = getMockStore({
+ *     store = createMockStore({
  *       initialState: { books: { entities: ['Book 1', 'Book 2', 'Book 3'] } },
  *       selectors: [
  *         { selector: selectAllBooks, value: ['Book 1', 'Book 2'] },
@@ -152,7 +160,7 @@ function mockStoreFactory<T>(
  * });
  * ```
  */
-export function getMockStore<T>(config: MockStoreConfig<T> = {}): MockStore<T> {
+export function createMockStore<T>(config: MockStoreConfig<T> = {}): MockStore<T> {
   const injector = Injector.create({ providers: provideMockStore(config) });
   return injector.get(MockStore);
 }

diff --git a/projects/ngrx.io/content/guide/effects/testing.md b/projects/ngrx.io/content/guide/effects/testing.md
@@ -307,12 +307,12 @@ it('should get customers', () => {
 })
 </code-example>
 
-For an Effect with store interaction, use `getMockStore` to create a new instance of `MockStore`.
+For an Effect with store interaction, use `createMockStore` to create a new instance of `MockStore`.
 
 <code-example header="my.effects.spec.ts">
 it('should get customers', () => {
   // create the store, and provide selectors.
-  const store = getMockStore({
+  const store = createMockStore({
       selectors: [
         { selector: selectCustomers, value: { Bob: { name: 'Bob' } } }
       ]

diff --git a/projects/ngrx.io/content/guide/migration/v15.md b/projects/ngrx.io/content/guide/migration/v15.md
@@ -251,6 +251,20 @@ export const usersFeature = createFeature({
 });
 ```
 
+#### Deprecated `getMockStore` in favor of `createMockStore`
+
+BEFORE:
+
+```ts
+import { getMockStore } from '@ngrx/store/testing';
+const mockStore = getMockStore();
+```
+
+```ts
+import { createMockStore } from '@ngrx/store/testing';
+const mockStore = createMockStore();
+```
+
 ### @ngrx/router-store
 
 #### Renamed `getSelectors` Function (Introduced in v15.2)

diff --git a/projects/ngrx.io/content/guide/store/testing.md b/projects/ngrx.io/content/guide/store/testing.md
@@ -128,17 +128,17 @@ describe('Books Component', () => {
 });
 </code-example>
 
-Another option to create the `MockStore` without `TestBed` is by calling the `getMockStore()` function:
+Another option to create the `MockStore` without `TestBed` is by calling the `createMockStore()` function:
 
 <code-example header="books.component.spec.ts">
-import { MockStore, getMockStore } from '@ngrx/store/testing';
+import { MockStore, createMockStore } from '@ngrx/store/testing';
 
 describe('Books Component', () => {
   let store: MockStore;
   const initialState = { books: ['Book 1', 'Book 2', 'Book 3'] };
 
   beforeEach(() => {    
-    store = getMockStore({ initialState });
+    store = createMockStore({ initialState });
   });
 });
 </code-example>