Options
All
  • Public
  • Public/Protected
  • All
Menu

This is the public interface of @angular-redux/store. It wraps the global redux store and adds a few other add on methods. It's what you'll inject into your Angular application as a service.

Type parameters

  • RootState

Hierarchy

  • NgRedux

Implements

Index

Properties

Abstract configureStore

configureStore: function

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.

param

Your app's root reducer

param

Your app's initial state

param

Optional Redux middlewares

param

Optional Redux store enhancers

Type declaration

    • (rootReducer: Reducer<RootState, AnyAction>, initState: RootState, middleware?: Middleware[], enhancers?: StoreEnhancer<RootState>[]): void
    • Parameters

      • rootReducer: Reducer<RootState, AnyAction>
      • initState: RootState
      • Optional middleware: Middleware[]
      • Optional enhancers: StoreEnhancer<RootState>[]

      Returns void

Abstract configureSubStore

configureSubStore: function

Type declaration

Abstract dispatch

dispatch: Dispatch<AnyAction>

Abstract getState

getState: function

Type declaration

    • (): RootState
    • Returns RootState

Abstract provideStore

provideStore: function

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. If configureStore has been used this cannot be used.

param

Your app's store

Type declaration

    • (store: Store<RootState>): void
    • Parameters

      • store: Store<RootState>

      Returns void

Abstract replaceReducer

replaceReducer: function

Type declaration

    • (nextReducer: Reducer<RootState, AnyAction>): void
    • Parameters

      • nextReducer: Reducer<RootState, AnyAction>

      Returns void

Abstract select

select: function

Type declaration

    • <SelectedType>(selector?: Selector<RootState, SelectedType>, comparator?: Comparator): Observable<SelectedType>
    • Type parameters

      • SelectedType

      Parameters

      Returns Observable<SelectedType>

Abstract subscribe

subscribe: function

Type declaration

    • (listener: function): Unsubscribe
    • Parameters

      • listener: function
          • (): void
          • Returns void

      Returns Unsubscribe

Static Optional instance

instance: ObservableStore<any> = undefined
hidden,

@deprecated

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc