WatcherConfig | Redux Kit

Hierarchy

IAsyncConfig
- WatcherConfig

Index

Properties

actionPrefix

actionPrefix: string

Main action type corresponding to action type prefix in createAsyncPagingReducer or createAsyncReducer

Optional getPromises

getPromises: null | ((state: any, action: any) => PromiseFunction[])

Optional listenOnceAtTime

listenOnceAtTime: boolean

Tell whether or not after spawning a task once, it blocks until spawned saga completes and then starts to listen for a task again. It is a choice of using between takeLatest and takeLeading in redux saga

Optional mapActionToPendingPayload

mapActionToPendingPayload: null | ((state: any, action: any) => object)

deprecated: Use mapPendingToPayload instead

Optional mapFailToPayload

mapFailToPayload: null | ((data: { action: any; error: any; rawError: any; state: any }) => { error: any })

Optional mapPendingToPayload

mapPendingToPayload: null | ((state: any, action: any) => object)

Map dispatched action to pending payload to be stored in reducer with a matched action type ending with _PENDING. Reference information createAsyncReducer or createAsyncPagingReducer

Optional mapResultToPayload

mapResultToPayload: null | ((state: any, action: any, results: any, rawResults: any[]) => any)

Map results from finished promises to a payload to be stored in reducer with a matched action type ending with _SUCCESS. Reference information createAsyncReducer or createAsyncPagingReducer

Optional resetIfCanceled

resetIfCanceled: boolean

Tell if need to reset a reducer when dispatching a action type action type ending with _CANCEL Reference information createAsyncReducer or createAsyncPagingReducer

Optional runInSequence

runInSequence: boolean

Tell if array of promise tasks or http tasks should run in parallel or sequence

Optional statuses

statuses: null | IAsyncStatus

Statues to be override

Optional takeType

takeType: "leading" | "latest" | "every"

Generated using TypeDoc