Class MockNgRedux<S>

Configures a Mock Redux store

Configures a Redux store and allows NgRedux to observe and dispatch to it. This should only be called once for the lifetime of your app, for example, in the constructor of your root component.

Config mock sub-store Carves off a 'subStore' or 'fractal' store from this one.

The returned object is itself an observable store, however, any selections, dispatches, or invocations of localReducer will be specific to that sub-store and will not know about the parent ObservableStore from which it was created.

Mock dispatch

A dispatching function (or simply dispatch function) is a function that accepts an actions or an async actions; it then may or may not dispatch one or more actions to the store.

Returns a subject that's connected to any observable returned by the given selector. You can use this subject to pump values into your components or services under test; when they call .select or

Select

in the context of a unit test, MockNgRedux will give them the values you pushed onto your stub.

  it('select ticket price data from the substore', async(() => {
    const mockSubStore = MockNgRedux.getSubStore(
      ['WALLABIES', 'items', 'id1']);

    const selectorStub = mockSubStore.getSelectorStub('ticketPrice');
    selectorStub.next(2);
    selectorStub.complete();

    animalComponent.ticketPrice$
      .subscribe(
        ticketPrice => expect(ticketPrice).toEqual(2));
  }));

Mock getState

Get store state

Returns a mock substore that allows you to set up selectorStubs for any 'fractal' stores your app creates with NgRedux.configureSubStore.

If your app creates deeply nested sub stores from another sub store, pass the chain of pathSelectors in as ordered arguments to mock the nested sub store out.

  it('select name data from the substore', async(() => {
    const mockSubStore = MockNgRedux.getSubStore(['WALLABIES', 'items', 'id1']);

    const selectorStub = mockSubStore.getSelectorStub('name');
    selectorStub.next('Wilbert');
    selectorStub.complete();

    animalComponent.name$
      .subscribe(
        name => expect(name).toEqual('Wilbert'));
  }));

Mock provideStore

Accepts a Redux store, then sets it in NgRedux and allows NgRedux to observe and dispatch to it. This should only be called once for the lifetime of your app, for example, in the constructor of your root component.

Mock replaceReducer

Replaces the reducer currently used by the store to calculate the state. You might need this if your app implements code splitting, and you want to load some reducers dynamically. You might also need this if you implement a hot reloading mechanism for Redux.

Reset all previously configured stubs.

MockNgRedux.reset();

Mock Select

Select a slice of state to expose as an observable.

Mock subscribe

Adds a change listener. It will be called any time an actions is dispatched, and some part of the state tree may potentially have changed. You may then call getState() to read the current state tree inside the callback.

Returns a subject that's connected to any observable returned by the given selector. You can use this subject to pump values into your components or services under test; when they call .select or

Select

in the context of a unit test, MockNgRedux will give them the values you pushed onto your stub.

  it('select ticket price data from the substore', async(() => {
    const mockSubStore = MockNgRedux.getSubStore(
      ['WALLABIES', 'items', 'id1']);

    const selectorStub = mockSubStore.getSelectorStub('ticketPrice');
    selectorStub.next(2);
    selectorStub.complete();

    animalComponent.ticketPrice$
      .subscribe(
        ticketPrice => expect(ticketPrice).toEqual(2));
  }));

Returns a mock substore that allows you to set up selectorStubs for any 'fractal' stores your app creates with NgRedux.configureSubStore.

If your app creates deeply nested sub stores from another sub store, pass the chain of pathSelectors in as ordered arguments to mock the nested sub store out.

  it('select name data from the substore', async(() => {
    const mockSubStore = MockNgRedux.getSubStore(['WALLABIES', 'items', 'id1']);

    const selectorStub = mockSubStore.getSelectorStub('name');
    selectorStub.next('Wilbert');
    selectorStub.complete();

    animalComponent.name$
      .subscribe(
        name => expect(name).toEqual('Wilbert'));
  }));

Reset all previously configured stubs.

MockNgRedux.reset();