Options
All
  • Public
  • Public/Protected
  • All
Menu

typed-redux-actions API documentation

Be sure to read the overview documentation before you dive into the API details.

Index

Type aliases

ActionTypeEnum

ActionTypeEnum: object

Type of the enum specifying the possible action types.

Example:

enum ActionType {
  set = 'SET_COUNTER',
  increment = 'INCREMENT_COUNTER'
}

Type declaration

Reduce

Reduce: function

Type for ActionReducer's reduce function.

(Need to explicitly specify this as undefined option for state will be missing in generated type declarations otherwise)

Type declaration

    • (state: State | undefined, action: Redux.AnyAction): State
    • Parameters

      • state: State | undefined
      • action: Redux.AnyAction

      Returns State

Variables

createStoreWithDevTools

createStoreWithDevTools: StoreCreator = /* tslint:disable-next-line */ /* istanbul ignore next */window['devToolsExtension'] ? window['devToolsExtension']()(createStore) : createStore

Drop-in replacement for Redux's createStore() function which will enhance the store using the redux-devtools-extension if installed in your browser.

Functions

actionFilter

declareAction

  • Creates an ActionDeclaration for the specified action creator. An ActionDeclaration provides type information for the action object returned by an action creator.

    Type parameters

    Parameters

    • create: function

      the action creator function

        • (...args: any[]): Action
        • Parameters

          • Rest ...args: any[]

          Returns Action

    Returns ActionDeclaration<Action>

    the ActionDeclaration providing type information for the action object provided by the creator.

Object literals

undefinedAction

undefinedAction: object

Action with an undefined type. Especially helpful for initialization and testing.

type

type: object

Type declaration

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