Module actions

Index

Interfaces

Type aliases

Functions

Type aliases

IDispatch

IDispatch: (action: IAction) => void

Type declaration

- (action: IAction): void
- Parameters
  - action: IAction
  Returns void

IMiddleware

IMiddleware<T>: (state: State<T>) => (next: IDispatch) => IDispatch

Type parameters

T

Type declaration

- (state: State<T>): (next: IDispatch) => IDispatch
- Parameters
  - state: State<T>
  Returns (next: IDispatch) => IDispatch
  - - (next: IDispatch): IDispatch
    - Parameters
      - next: IDispatch
      Returns IDispatch

IReducer

IReducer<T>: (lastState: T, action: IAction) => T

Type parameters

T

Type declaration

- (lastState: T, action: IAction): T
- Parameters
  - lastState: T
  - action: IAction
  Returns T

Functions

createAction

createAction(type: string): { create: () => IAction; getType: () => string; is: (value: any) => value is IAction }

- Defined in src/actions.ts:20
Parameters
- type: string
Returns { create: () => IAction; getType: () => string; is: (value: any) => value is IAction }
- create: () => IAction
  - - (): IAction
    - Returns IAction
- getType: () => string
  - - (): string
    - Returns string
- is: (value: any) => value is IAction
  - - (value: any): value is IAction
    - Parameters
      - value: any
      Returns value is IAction

createActionWithPayload

createActionWithPayload<T>(type: string): { create: (payload: T) => IActionWithPayload<T>; getType: () => string; is: (value: any) => value is IActionWithPayload<T> }

- Defined in src/actions.ts:36
Type parameters
- T
Parameters
- type: string
Returns { create: (payload: T) => IActionWithPayload<T>; getType: () => string; is: (value: any) => value is IActionWithPayload<T> }
- create: (payload: T) => IActionWithPayload<T>
  - - (payload: T): IActionWithPayload<T>
    - Parameters
      - payload: T
      Returns IActionWithPayload<T>
- getType: () => string
  - - (): string
    - Returns string
- is: (value: any) => value is IActionWithPayload<T>
  - - (value: any): value is IActionWithPayload<T>
    - Parameters
      - value: any
      Returns value is IActionWithPayload<T>

createDispatcher

createDispatcher<T>(state: State<T>, reducer: IReducer<RecordOf<T>>, middleware?: IMiddleware<T>): IDispatch

- Defined in src/actions.ts:95
Type parameters
- T
Parameters
- state: State<T>
- reducer: IReducer<RecordOf<T>>
- middleware: IMiddleware<T> = defaultMiddleware
Returns IDispatch

isAction

isAction(value: any): value is IAction

- Defined in src/actions.ts:14
Parameters
- value: any
Returns value is IAction

mergeMiddleware

mergeMiddleware<T>(...middlewares: IMiddleware<T>[]): IMiddleware<T>

- Defined in src/actions.ts:85
Type parameters
- T
Parameters
- Rest ...middlewares: IMiddleware<T>[]
Returns IMiddleware<T>

mergeReducers

mergeReducers<T>(reducers: Record<IStringKeyOf<T>, IReducer<IValueOf<T>>>): IReducer<RecordOf<T>>

- Defined in src/actions.ts:54
Type parameters
- T
Parameters
- reducers: Record<IStringKeyOf<T>, IReducer<IValueOf<T>>>
Returns IReducer<RecordOf<T>>

Generated using TypeDoc