Installation
npm install --save @types/redux-saga-tester
Summary
This package contains type definitions for redux-saga-tester (https://github.com/wix/redux-saga-tester#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-saga-tester.
index.d.ts
import { AnyAction, Middleware, Reducer, ReducersMapObject, Store } from "redux";
import { Task } from "redux-saga";
export type SagaFunction = (...args: any[]) => any;
export interface SagaTesterOptions<StateType> {
initialState?: StateType | undefined;
reducers?: ReducersMapObject | Reducer<StateType> | undefined;
middlewares?: Middleware[] | undefined;
combineReducers?: ((map: ReducersMapObject) => Reducer<StateType>) | undefined;
ignoreReduxActions?: boolean | undefined;
options?: object | undefined;
}
export default class SagaTester<StateType extends object> {
constructor(options?: SagaTesterOptions<StateType>);
/**
* The reference of the redux store.
*/
store: Store<StateType>;
/**
* Starts execution of the provided saga.
*/
start(saga: SagaFunction, ...args: any[]): Task;
/**
* Dispatches an action to the redux store.
*/
dispatch(action: AnyAction): void;
/**
* Assigns the newState into the current state. (Only works with the default reducer.)
*/
updateState(state: StateType): void;
/**
* Returns the state of the redux store.
*/
getState(): StateType;
/**
* Returns a promise that will resolve if the specified action is dispatched to the store.
* @param actionType Action name.
* @param futureOnly Causes waitFor to only resolve if the action is called in the future.
*/
waitFor(actionType: string, futureOnly?: boolean): PromiseLike<AnyAction>;
/**
* Returns whether the specified was dispatched in the past.
*/
wasCalled(actionType: string): boolean;
/**
* Returns the number of times an action with the given type was dispatched.
*/
numCalled(actionType: string): number;
/**
* Returns the last action dispatched to the store.
*/
getLatestCalledAction(): AnyAction;
/**
* Returns an array of all actions dispatched.
*/
getCalledActions(): AnyAction[];
/**
* Reset the store state back to initialState
* @param clearActionList Clears the history of past actions (defaults to false).
*/
reset(clearActionList?: boolean): void;
}
Additional Details
- Last updated: Tue, 07 Nov 2023 15:11:36 GMT
- Dependencies: redux, redux-saga
Credits
These definitions were written by Ben Lorantfy, Law Smith, and Björn Böing.