@reduxjs/toolkit

import { ActionCreator, Action, Middleware, StoreEnhancer, UnknownAction, Reducer, ReducersMapObject, Store, StateFromReducersMapObject, Dispatch, MiddlewareAPI } from 'redux'; export * from 'redux'; import { Draft } from 'immer'; export { Draft, produce as createNextState, current, freeze, isDraft, original } from 'immer'; import * as reselect from 'reselect'; import { weakMapMemoize, createSelectorCreator, Selector, CreateSelectorFunction } from 'reselect'; export { OutputSelector, Selector, createSelector, createSelectorCreator, lruMemoize, weakMapMemoize } from 'reselect'; import { ThunkMiddleware, ThunkDispatch } from 'redux-thunk'; export { ThunkAction, ThunkDispatch, ThunkMiddleware } from 'redux-thunk'; import { UncheckedIndexedAccess } from './uncheckedindexed.js'; declare const createDraftSafeSelectorCreator: typeof createSelectorCreator; /** * "Draft-Safe" version of `reselect`'s `createSelector`: * If an `immer`-drafted object is passed into the resulting selector's first argument, * the selector will act on the current draft value, instead of returning a cached value * that might be possibly outdated if the draft has been modified since. * @public */ declare const createDraftSafeSelector: reselect.CreateSelectorFunction<typeof weakMapMemoize, typeof weakMapMemoize, any>; /** * @public */ interface DevToolsEnhancerOptions { /** * the instance name to be showed on the monitor page. Default value is `document.title`. * If not specified and there's no document title, it will consist of `tabId` and `instanceId`. */ name?: string; /** * action creators functions to be available in the Dispatcher. */ actionCreators?: ActionCreator<any>[] | { [key: string]: ActionCreator<any>; }; /** * if more than one action is dispatched in the indicated interval, all new actions will be collected and sent at once. * It is the joint between performance and speed. When set to `0`, all actions will be sent instantly. * Set it to a higher value when experiencing perf issues (also `maxAge` to a lower value). * * @default 500 ms. */ latency?: number; /** * (> 1) - maximum allowed actions to be stored in the history tree. The oldest actions are removed once maxAge is reached. It's critical for performance. * * @default 50 */ maxAge?: number; /** * Customizes how actions and state are serialized and deserialized. Can be a boolean or object. If given a boolean, the behavior is the same as if you * were to pass an object and specify `options` as a boolean. Giving an object allows fine-grained customization using the `replacer` and `reviver` * functions. */ serialize?: boolean | { /** * - `undefined` - will use regular `JSON.stringify` to send data (it's the fast mode). * - `false` - will handle also circular references. * - `true` - will handle also date, regex, undefined, error objects, symbols, maps, sets and functions. * - object, which contains `date`, `regex`, `undefined`, `error`, `symbol`, `map`, `set` and `function` keys. * For each of them you can indicate if to include (by setting as `true`). * For `function` key you can also specify a custom function which handles serialization. * See [`jsan`](https://github.com/kolodny/jsan) for more details. */ options?: undefined | boolean | { date?: true; regex?: true; undefined?: true; error?: true; symbol?: true; map?: true; set?: true; function?: true | ((fn: (...args: any[]) => any) => string); }; /** * [JSON replacer function](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter) used for both actions and states stringify. * In addition, you can specify a data type by adding a [`__serializedType__`](https://github.com/zalmoxisus/remotedev-serialize/blob/master/helpers/index.js#L4) * key. So you can deserialize it back while importing or persisting data. * Moreover, it will also [show a nice preview showing the provided custom type](https://cloud.githubusercontent.com/assets/7957859/21814330/a17d556a-d761-11e6-85ef-159dd12f36c5.png): */ replacer?: (key: string, value: unknown) => any; /** * [JSON `reviver` function](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter) * used for parsing the imported actions and states. See [`remotedev-serialize`](https://github.com/zalmoxisus/remotedev-serialize/blob/master/immutable/serialize.js#L8-L41) * as an example on how to serialize special data types and get them back. */ reviver?: (key: string, value: unknown) => any; /** * Automatically serialize/deserialize immutablejs via [remotedev-serialize](https://github.com/zalmoxisus/remotedev-serialize). * Just pass the Immutable library. It will support all ImmutableJS structures. You can even export them into a file and get them back. * The only exception is `Record` class, for which you should pass this in addition the references to your classes in `refs`. */ immutable?: any; /** * ImmutableJS `Record` classes used to make possible restore its instances back when importing, persisting... */ refs?: any; }; /** * function which takes `action` object and id number as arguments, and should return `action` object back. */ actionSanitizer?: <A extends Action>(action: A, id: number) => A; /** * function which takes `state` object and index as arguments, and should return `state` object back. */ stateSanitizer?: <S>(state: S, index: number) => S; /** * *string or array of strings as regex* - actions types to be hidden / shown in the monitors (while passed to the reducers). * If `actionsAllowlist` specified, `actionsDenylist` is ignored. */ actionsDenylist?: string | string[]; /** * *string or array of strings as regex* - actions types to be hidden / shown in the monitors (while passed to the reducers). * If `actionsAllowlist` specified, `actionsDenylist` is ignored. */ actionsAllowlist?: string | string[]; /** * called for every action before sending, takes `state` and `action` object, and returns `true` in case it allows sending the current data to the monitor. * Use it as a more advanced version of `actionsDenylist`/`actionsAllowlist` parameters. */ predicate?: <S, A extends Action>(state: S, action: A) => boolean; /** * if specified as `false`, it will not record the changes till clicking on `Start recording` button. * Available only for Redux enhancer, for others use `autoPause`. * * @default true */ shouldRecordChanges?: boolean; /** * if specified, whenever clicking on `Pause recording` button and there are actions in the history log, will add this action type. * If not specified, will commit when paused. Available only for Redux enhancer. * * @default "@@PAUSED"" */ pauseActionType?: string; /** * auto pauses when the extension’s window is not opened, and so has zero impact on your app when not in use. * Not available for Redux enhancer (as it already does it but storing the data to be sent). * * @default false */ autoPause?: boolean; /** * if specified as `true`, it will not allow any non-monitor actions to be dispatched till clicking on `Unlock changes` button. * Available only for Redux enhancer. * * @default false */ shouldStartLocked?: boolean; /** * if set to `false`, will not recompute the states on hot reloading (or on replacing the reducers). Available only for Redux enhancer. * * @default true */ shouldHotReload?: boolean; /** * if specified as `true`, whenever there's an exception in reducers, the monitors will show the error message, and next actions will not be dispatched. * * @default false */ shouldCatchErrors?: boolean; /** * If you want to restrict the extension, specify the features you allow. * If not specified, all of the features are enabled. When set as an object, only those included as `true` will be allowed. * Note that except `true`/`false`, `import` and `export` can be set as `custom` (which is by default for Redux enhancer), meaning that the importing/exporting occurs on the client side. * Otherwise, you'll get/set the data right from the monitor part. */ features?: { /** * start/pause recording of dispatched actions */ pause?: boolean; /** * lock/unlock dispatching actions and side effects */ lock?: boolean; /** * persist states on page reloading */ persist?: boolean; /** * export history of actions in a file */ export?: boolean | 'custom'; /** * import history of actions from a file */ import?: boolean | 'custom'; /** * jump back and forth (time travelling) */ jump?: boolean; /** * skip (cancel) actions */ skip?: boolean; /** * drag and drop actions in the history list */ reorder?: boolean; /** * dispatch custom actions or action creators */ dispatch?: boolean; /** * generate tests for the selected actions */ test?: boolean; }; /** * Set to true or a stacktrace-returning function to record call stack traces for dispatched actions. * Defaults to false. */ trace?: boolean | (<A extends Action>(action: A) => string); /** * The maximum number of stack trace entries to record per action. Defaults to 10. */ traceLimit?: number; } interface ActionCreatorInvariantMiddlewareOptions { /** * The function to identify whether a value is an action creator. * The default checks for a function with a static type property and match method. */ isActionCreator?: (action: unknown) => action is Function & { type?: unknown; }; } declare function createActionCreatorInvariantMiddleware(options?: ActionCreatorInvariantMiddlewareOptions): Middleware; /** * Returns true if the passed value is "plain", i.e. a value that is either * directly JSON-serializable (boolean, number, string, array, plain object) * or `undefined`. * * @param val The value to check. * * @public */ declare function isPlain(val: any): boolean; interface NonSerializableValue { keyPath: string; value: unknown; } type IgnorePaths = readonly (string | RegExp)[]; /** * @public */ declare function findNonSerializableValue(value: unknown, path?: string, isSerializable?: (value: unknown) => boolean, getEntries?: (value: unknown) => [string, any][], ignoredPaths?: IgnorePaths, cache?: WeakSet<object>): NonSerializableValue | false; /** * Options for `createSerializableStateInvariantMiddleware()`. * * @public */ interface SerializableStateInvariantMiddlewareOptions { /** * The function to check if a value is considered serializable. This * function is applied recursively to every value contained in the * state. Defaults to `isPlain()`. */ isSerializable?: (value: any) => boolean; /** * The function that will be used to retrieve entries from each * value. If unspecified, `Object.entries` will be used. Defaults * to `undefined`. */ getEntries?: (value: any) => [string, any][]; /** * An array of action types to ignore when checking for serializability. * Defaults to [] */ ignoredActions?: string[]; /** * An array of dot-separated path strings or regular expressions to ignore * when checking for serializability, Defaults to * ['meta.arg', 'meta.baseQueryMeta'] */ ignoredActionPaths?: (string | RegExp)[]; /** * An array of dot-separated path strings or regular expressions to ignore * when checking for serializability, Defaults to [] */ ignoredPaths?: (string | RegExp)[]; /** * Execution time warning threshold. If the middleware takes longer * than `warnAfter` ms, a warning will be displayed in the console. * Defaults to 32ms. */ warnAfter?: number; /** * Opt out of checking state. When set to `true`, other state-related params will be ignored. */ ignoreState?: boolean; /** * Opt out of checking actions. When set to `true`, other action-related params will be ignored. */ ignoreActions?: boolean; /** * Opt out of caching the results. The cache uses a WeakSet and speeds up repeated checking processes. * The cache is automatically disabled if no browser support for WeakSet is present. */ disableCache?: boolean; } /** * Creates a middleware that, after every state change, checks if the new * state is serializable. If a non-serializable value is found within the * state, an error is printed to the console. * * @param options Middleware options. * * @public */ declare function createSerializableStateInvariantMiddleware(options?: SerializableStateInvariantMiddlewareOptions): Middleware; /** * The default `isImmutable` function. * * @public */ declare function isImmutableDefault(value: unknown): boolean; type IsImmutableFunc = (value: any) => boolean; /** * Options for `createImmutableStateInvariantMiddleware()`. * * @public */ interface ImmutableStateInvariantMiddlewareOptions { /** Callback function to check if a value is considered to be immutable. This function is applied recursively to every value contained in the state. The default implementation will return true for primitive types (like numbers, strings, booleans, null and undefined). */ isImmutable?: IsImmutableFunc; /** An array of dot-separated path strings that match named nodes from the root state to ignore when checking for immutability. Defaults to undefined */ ignoredPaths?: IgnorePaths; /** Print a warning if checks take longer than N ms. Default: 32ms */ warnAfter?: number; } /** * Creates a middleware that checks whether any state was mutated in between * dispatches or during a dispatch. If any mutations are detected, an error is * thrown. * * @param options Middleware options. * * @public */ declare function createImmutableStateInvariantMiddleware(options?: ImmutableStateInvariantMiddlewareOptions): Middleware; declare class Tuple<Items extends ReadonlyArray<unknown> = []> extends Array<Items[number]> { constructor(length: number); constructor(...items: Items); static get [Symbol.species](): any; concat<AdditionalItems extends ReadonlyArray<unknown>>(items: Tuple<AdditionalItems>): Tuple<[...Items, ...AdditionalItems]>; concat<AdditionalItems extends ReadonlyArray<unknown>>(items: AdditionalItems): Tuple<[...Items, ...AdditionalItems]>; concat<AdditionalItems extends ReadonlyArray<unknown>>(...items: AdditionalItems): Tuple<[...Items, ...AdditionalItems]>; prepend<AdditionalItems extends ReadonlyArray<unknown>>(items: Tuple<AdditionalItems>): Tuple<[...AdditionalItems, ...Items]>; prepend<AdditionalItems extends ReadonlyArray<unknown>>(items: AdditionalItems): Tuple<[...AdditionalItems, ...Items]>; prepend<AdditionalItems extends ReadonlyArray<unknown>>(...items: AdditionalItems): Tuple<[...AdditionalItems, ...Items]>; } /** * return True if T is `any`, otherwise return False * taken from https://github.com/joonhocho/tsdef * * @internal */ type IsAny<T, True, False = never> = true | false extends (T extends never ? true : false) ? True : False; type CastAny<T, CastTo> = IsAny<T, CastTo, T>; /** * return True if T is `unknown`, otherwise return False * taken from https://github.com/joonhocho/tsdef * * @internal */ type IsUnknown<T, True, False = never> = unknown extends T ? IsAny<T, False, True> : False; type FallbackIfUnknown<T, Fallback> = IsUnknown<T, Fallback, T>; /** * @internal */ type IfMaybeUndefined<P, True, False> = [undefined] extends [P] ? True : False; /** * @internal */ type IfVoid<P, True, False> = [void] extends [P] ? True : False; /** * @internal */ type IsEmptyObj<T, True, False = never> = T extends any ? keyof T extends never ? IsUnknown<T, False, IfMaybeUndefined<T, False, IfVoid<T, False, True>>> : False : never; /** * returns True if TS version is above 3.5, False if below. * uses feature detection to detect TS version >= 3.5 * * versions below 3.5 will return `{}` for unresolvable interference * * versions above will return `unknown` * * @internal */ type AtLeastTS35<True, False> = [True, False][IsUnknown<ReturnType<(<T>() => T)>, 0, 1>]; /** * @internal */ type IsUnknownOrNonInferrable<T, True, False> = AtLeastTS35<IsUnknown<T, True, False>, IsEmptyObj<T, True, IsUnknown<T, True, False>>>; /** * Convert a Union type `(A|B)` to an intersection type `(A&B)` */ type UnionToIntersection = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never; type ExcludeFromTuple<T, E, Acc extends unknown[] = []> = T extends [ infer Head, ...infer Tail ] ? ExcludeFromTuple<Tail, E, [...Acc, ...([Head] extends [E] ? [] : [Head])]> : Acc; type ExtractDispatchFromMiddlewareTuple<MiddlewareTuple extends readonly any[], Acc extends {}> = MiddlewareTuple extends [infer Head, ...infer Tail] ? ExtractDispatchFromMiddlewareTuple<Tail, Acc & (Head extends Middleware<infer D> ? IsAny<D, {}, D> : {})> : Acc; type ExtractDispatchExtensions<M> = M extends Tuple<infer MiddlewareTuple> ? ExtractDispatchFromMiddlewareTuple<MiddlewareTuple, {}> : M extends ReadonlyArray<Middleware> ? ExtractDispatchFromMiddlewareTuple<[...M], {}> : never; type ExtractStoreExtensionsFromEnhancerTuple<EnhancerTuple extends readonly any[], Acc extends {}> = EnhancerTuple extends [infer Head, ...infer Tail] ? ExtractStoreExtensionsFromEnhancerTuple<Tail, Acc & (Head extends StoreEnhancer<infer Ext> ? IsAny<Ext, {}, Ext> : {})> : Acc; type ExtractStoreExtensions<E> = E extends Tuple<infer EnhancerTuple> ? ExtractStoreExtensionsFromEnhancerTuple<EnhancerTuple, {}> : E extends ReadonlyArray<StoreEnhancer> ? UnionToIntersection<E[number] extends StoreEnhancer<infer Ext> ? Ext extends {} ? IsAny<Ext, {}, Ext> : {} : {}> : never; type ExtractStateExtensionsFromEnhancerTuple<EnhancerTuple extends readonly any[], Acc extends {}> = EnhancerTuple extends [infer Head, ...infer Tail] ? ExtractStateExtensionsFromEnhancerTuple<Tail, Acc & (Head extends StoreEnhancer<any, infer StateExt> ? IsAny<StateExt, {}, StateExt> : {})> : Acc; type ExtractStateExtensions<E> = E extends Tuple<infer EnhancerTuple> ? ExtractStateExtensionsFromEnhancerTuple<EnhancerTuple, {}> : E extends ReadonlyArray<StoreEnhancer> ? UnionToIntersection<E[number] extends StoreEnhancer<any, infer StateExt> ? StateExt extends {} ? IsAny<StateExt, {}, StateExt> : {} : {}> : never; /** * Helper type. Passes T out again, but boxes it in a way that it cannot * "widen" the type by accident if it is a generic that should be inferred * from elsewhere. * * @internal */ type NoInfer<T> = [T][T extends any ? 0 : never]; type NonUndefined<T> = T extends undefined ? never : T; type WithRequiredProp<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>; type WithOptionalProp<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>; interface TypeGuard<T> { (value: any): value is T; } interface HasMatchFunction<T> { match: TypeGuard<T>; } /** @public */ type Matcher<T> = HasMatchFunction<T> | TypeGuard<T>; /** @public */ type ActionFromMatcher<M extends Matcher<any>> = M extends Matcher<infer T> ? T : never; type Id<T> = { [K in keyof T]: T[K]; } & {}; type Tail<T extends any[]> = T extends [any, ...infer Tail] ? Tail : never; type UnknownIfNonSpecific<T> = {} extends T ? unknown : T; /** * A Promise that will never reject. * @see https://github.com/reduxjs/redux-toolkit/issues/4101 */ type SafePromise<T> = Promise<T> & { __linterBrands: 'SafePromise'; }; interface ThunkOptions<E = any> { extraArgument: E; } interface GetDefaultMiddlewareOptions { thunk?: boolean | ThunkOptions; immutableCheck?: boolean | ImmutableStateInvariantMiddlewareOptions; serializableCheck?: boolean | SerializableStateInvariantMiddlewareOptions; actionCreatorCheck?: boolean | ActionCreatorInvariantMiddlewareOptions; } type ThunkMiddlewareFor<S, O extends GetDefaultMiddlewareOptions = {}> = O extends { thunk: false; } ? never : O extends { thunk: { extraArgument: infer E; }; } ? ThunkMiddleware<S, UnknownAction, E> : ThunkMiddleware<S, UnknownAction>; type GetDefaultMiddleware<S = any> = <O extends GetDefaultMiddlewareOptions = { thunk: true; immutableCheck: true; serializableCheck: true; actionCreatorCheck: true; }>(options?: O) => Tuple<ExcludeFromTuple<[ThunkMiddlewareFor<S, O>], never>>; declare const SHOULD_AUTOBATCH = "RTK_autoBatch"; declare const prepareAutoBatched: <T>() => (payload: T) => { payload: T; meta: unknown; }; type AutoBatchOptions = { type: 'tick'; } | { type: 'timer'; timeout: number; } | { type: 'raf'; } | { type: 'callback'; queueNotification: (notify: () => void) => void; }; /** * A Redux store enhancer that watches for "low-priority" actions, and delays * notifying subscribers until either the queued callback executes or the * next "standard-priority" action is dispatched. * * This allows dispatching multiple "low-priority" actions in a row with only * a single subscriber notification to the UI after the sequence of actions * is finished, thus improving UI re-render performance. * * Watches for actions with the `action.meta[SHOULD_AUTOBATCH]` attribute. * This can be added to `action.meta` manually, or by using the * `prepareAutoBatched` helper. * * By default, it will queue a notification for the end of the event loop tick. * However, you can pass several other options to configure the behavior: * - `{type: 'tick'}`: queues using `queueMicrotask` * - `{type: 'timer', timeout: number}`: queues using `setTimeout` * - `{type: 'raf'}`: queues using `requestAnimationFrame` (default) * - `{type: 'callback', queueNotification: (notify: () => void) => void}`: lets you provide your own callback * * */ declare const autoBatchEnhancer: (options?: AutoBatchOptions) => StoreEnhancer; type GetDefaultEnhancersOptions = { autoBatch?: boolean | AutoBatchOptions; }; type GetDefaultEnhancers<M extends Middlewares<any>> = (options?: GetDefaultEnhancersOptions) => Tuple<[StoreEnhancer<{ dispatch: ExtractDispatchExtensions<M>; }>]>; /** * Options for `configureStore()`. * * @public */ interface ConfigureStoreOptions<S = any, A extends Action = UnknownAction, M extends Tuple<Middlewares<S>> = Tuple<Middlewares<S>>, E extends Tuple<Enhancers> = Tuple<Enhancers>, P = S> { /** * A single reducer function that will be used as the root reducer, or an * object of slice reducers that will be passed to `combineReducers()`. */ reducer: Reducer<S, A, P> | ReducersMapObject<S, A, P>; /** * An array of Redux middleware to install, or a callback receiving `getDefaultMiddleware` and returning a Tuple of middleware. * If not supplied, defaults to the set of middleware returned by `getDefaultMiddleware()`. * * @example `middleware: (gDM) => gDM().concat(logger, apiMiddleware, yourCustomMiddleware)` * @see https://redux-toolkit.js.org/api/getDefaultMiddleware#intended-usage */ middleware?: (getDefaultMiddleware: GetDefaultMiddleware<S>) => M; /** * Whether to enable Redux DevTools integration. Defaults to `true`. * * Additional configuration can be done by passing Redux DevTools options */ devTools?: boolean | DevToolsEnhancerOptions; /** * Whether to check for duplicate middleware instances. Defaults to `true`. */ duplicateMiddlewareCheck?: boolean; /** * The initial state, same as Redux's createStore. * You may optionally specify it to hydrate the state * from the server in universal apps, or to restore a previously serialized * user session. If you use `combineReducers()` to produce the root reducer * function (either directly or indirectly by passing an object as `reducer`), * this must be an object with the same shape as the reducer map keys. */ preloadedState?: P; /** * The store enhancers to apply. See Redux's `createStore()`. * All enhancers will be included before the DevTools Extension enhancer. * If you need to customize the order of enhancers, supply a callback * function that will receive a `getDefaultEnhancers` function that returns a Tuple, * and should return a Tuple of enhancers (such as `getDefaultEnhancers().concat(offline)`). * If you only need to add middleware, you can use the `middleware` parameter instead. */ enhancers?: (getDefaultEnhancers: GetDefaultEnhancers<M>) => E; } type Middlewares<S> = ReadonlyArray<Middleware<{}, S>>; type Enhancers = ReadonlyArray<StoreEnhancer>; /** * A Redux store returned by `configureStore()`. Supports dispatching * side-effectful _thunks_ in addition to plain actions. * * @public */ type EnhancedStore<S = any, A extends Action = UnknownAction, E extends Enhancers = Enhancers> = ExtractStoreExtensions<E> & Store<S, A, UnknownIfNonSpecific<ExtractStateExtensions<E>>>; /** * A friendly abstraction over the standard Redux `createStore()` function. * * @param options The store configuration. * @returns A configured Redux store. * * @public */ declare function configureStore<S = any, A extends Action = UnknownAction, M extends Tuple<Middlewares<S>> = Tuple<[ThunkMiddlewareFor<S>]>, E extends Tuple<Enhancers> = Tuple<[ StoreEnhancer<{ dispatch: ExtractDispatchExtensions<M>; }>, StoreEnhancer ]>, P = S>(options: ConfigureStoreOptions<S, A, M, E, P>): EnhancedStore<S, A, E>; /** * An action with a string type and an associated payload. This is the * type of action returned by `createAction()` action creators. * * @template P The type of the action's payload. * @template T the type used for the action type. * @template M The type of the action's meta (optional) * @template E The type of the action's error (optional) * * @public */ type PayloadAction = { payload: P; type: T; } & ([M] extends [never] ? {} : { meta: M; }) & ([E] extends [never] ? {} : { error: E; }); /** * A "prepare" method to be used as the second parameter of `createAction`. * Takes any number of arguments and returns a Flux Standard Action without * type (will be added later) that *must* contain a payload (might be undefined). * * @public */ type PrepareAction = ((...args: any[]) => { payload: P; }) | ((...args: any[]) => { payload: P; meta: any; }) | ((...args: any[]) => { payload: P; error: any; }) | ((...args: any[]) => { payload: P; meta: any; error: any; }); /** * Internal version of `ActionCreatorWithPreparedPayload`. Not to be used externally. * * @internal */ type _ActionCreatorWithPreparedPayload<PA extends PrepareAction<any> | void, T extends string = string> = PA extends PrepareAction<infer P> ? ActionCreatorWithPreparedPayload<Parameters<PA>, P, T, ReturnType<PA> extends { error: infer E; } ? E : never, ReturnType<PA> extends { meta: infer M; } ? M : never> : void; /** * Basic type for all action creators. * * @inheritdoc {redux#ActionCreator} */ type BaseActionCreator<P, T extends string, M = never, E = never> = { type: T; match: (action: unknown) => action is PayloadAction<P, T, M, E>; }; /** * An action creator that takes multiple arguments that are passed * to a `PrepareAction` method to create the final Action. * @typeParam Args arguments for the action creator function * @typeParam P `payload` type * @typeParam T `type` name * @typeParam E optional `error` type * @typeParam M optional `meta` type * * @inheritdoc {redux#ActionCreator} * * @public */ interface ActionCreatorWithPreparedPayload<Args extends unknown[], P, T extends string = string, E = never, M = never> extends BaseActionCreator<P, T, M, E> { /** * Calling this {@link redux#ActionCreator} with `Args` will return * an Action with a payload of type `P` and (depending on the `PrepareAction` * method used) a `meta`- and `error` property of types `M` and `E` respectively. */ (...args: Args): PayloadAction<P, T, M, E>; } /** * An action creator of type `T` that takes an optional payload of type `P`. * * @inheritdoc {redux#ActionCreator} * * @public */ interface ActionCreatorWithOptionalPayload<P, T extends string = string> extends BaseActionCreator<P, T> { /** * Calling this {@link redux#ActionCreator} with an argument will * return a {@link PayloadAction} of type `T` with a payload of `P`. * Calling it without an argument will return a PayloadAction with a payload of `undefined`. */ (payload?: P): PayloadAction<P, T>; } /** * An action creator of type `T` that takes no payload. * * @inheritdoc {redux#ActionCreator} * * @public */ interface ActionCreatorWithoutPayload<T extends string = string> extends BaseActionCreator<undefined, T> { /** * Calling this {@link redux#ActionCreator} will * return a {@link PayloadAction} of type `T` with a payload of `undefined` */ (noArgument: void): PayloadAction<undefined, T>; } /** * An action creator of type `T` that requires a payload of type P. * * @inheritdoc {redux#ActionCreator} * * @public */ interface ActionCreatorWithPayload<P, T extends string = string> extends BaseActionCreator<P, T> { /** * Calling this {@link redux#ActionCreator} with an argument will * return a {@link PayloadAction} of type `T` with a payload of `P` */ (payload: P): PayloadAction<P, T>; } /** * An action creator of type `T` whose `payload` type could not be inferred. Accepts everything as `payload`. * * @inheritdoc {redux#ActionCreator} * * @public */ interface ActionCreatorWithNonInferrablePayload<T extends string = string> extends BaseActionCreator<unknown, T> { /** * Calling this {@link redux#ActionCreator} with an argument will * return a {@link PayloadAction} of type `T` with a payload * of exactly the type of the argument. */ <PT extends unknown>(payload: PT): PayloadAction<PT, T>; } /** * An action creator that produces actions with a `payload` attribute. * * @typeParam P the `payload` type * @typeParam T the `type` of the resulting action * @typeParam PA if the resulting action is preprocessed by a `prepare` method, the signature of said method. * * @public */ type PayloadActionCreator | void = void> = IfPrepareActionMethodProvided<PA, _ActionCreatorWithPreparedPayload<PA, T>, IsAny<P, ActionCreatorWithPayload<any, T>, IsUnknownOrNonInferrable<P, ActionCreatorWithNonInferrablePayload<T>, IfVoid<P, ActionCreatorWithoutPayload<T>, IfMaybeUndefined<P, ActionCreatorWithOptionalPayload<P, T>, ActionCreatorWithPayload<P, T>>>>>>; /** * A utility function to create an action creator for the given action type * string. The action creator accepts a single argument, which will be included * in the action object as a field called payload. The action creator function * will also have its toString() overridden so that it returns the action type. * * @param type The action type to use for created actions. * @param prepare (optional) a method that takes any number of arguments and returns { payload } or { payload, meta }. * If this is given, the resulting action creator will pass its arguments to this method to calculate payload & meta. * * @public */ declare function createAction(type: T): PayloadActionCreator<P, T>; /** * A utility function to create an action creator for the given action type * string. The action creator accepts a single argument, which will be included * in the action object as a field called payload. The action creator function * will also have its toString() overridden so that it returns the action type. * * @param type The action type to use for created actions. * @param prepare (optional) a method that takes any number of arguments and returns { payload } or { payload, meta }. * If this is given, the resulting action creator will pass its arguments to this method to calculate payload & meta. * * @public */ declare function createAction<PA extends PrepareAction<any>, T extends string = string>(type: T, prepareAction: PA): PayloadActionCreator<ReturnType<PA>['payload'], T, PA>; /** * Returns true if value is an RTK-like action creator, with a static type property and match method. */ declare function isActionCreator(action: unknown): action is BaseActionCreator<unknown, string> & Function; /** * Returns true if value is an action with a string type and valid Flux Standard Action keys. */ declare function isFSA(action: unknown): action is { type: string; payload?: unknown; error?: unknown; meta?: unknown; }; type IfPrepareActionMethodProvided<PA extends PrepareAction<any> | void, True, False> = PA extends (...args: any[]) => any ? True : False; type TypedActionCreator<Type extends string> = { (...args: any[]): Action<Type>; type: Type; }; /** * A builder for an action <-> reducer map. * * @public */ interface ActionReducerMapBuilder<State> { /** * Adds a case reducer to handle a single exact action type. * @remarks * All calls to `builder.addCase` must come before any calls to `builder.addMatcher` or `builder.addDefaultCase`. * @param actionCreator - Either a plain action type string, or an action creator generated by [`createAction`](./createAction) that can be used to determine the action type. * @param reducer - The actual case reducer function. */ addCase<ActionCreator extends TypedActionCreator<string>>(actionCreator: ActionCreator, reducer: CaseReducer<State, ReturnType<ActionCreator>>): ActionReducerMapBuilder<State>; /** * Adds a case reducer to handle a single exact action type. * @remarks * All calls to `builder.addCase` must come before any calls to `builder.addMatcher` or `builder.addDefaultCase`. * @param actionCreator - Either a plain action type string, or an action creator generated by [`createAction`](./createAction) that can be used to determine the action type. * @param reducer - The actual case reducer function. */ addCase<Type extends string, A extends Action<Type>>(type: Type, reducer: CaseReducer<State, A>): ActionReducerMapBuilder<State>; /** * Allows you to match your incoming actions against your own filter function instead of only the `action.type` property. * @remarks * If multiple matcher reducers match, all of them will be executed in the order * they were defined in - even if a case reducer already matched. * All calls to `builder.addMatcher` must come after any calls to `builder.addCase` and before any calls to `builder.addDefaultCase`. * @param matcher - A matcher function. In TypeScript, this should be a [type predicate](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates) * function * @param reducer - The actual case reducer function. * * @example ```ts import { createAction, createReducer, AsyncThunk, UnknownAction, } from "@reduxjs/toolkit"; type GenericAsyncThunk = AsyncThunk<unknown, unknown, any>; type PendingAction = ReturnType<GenericAsyncThunk["pending"]>; type RejectedAction = ReturnType<GenericAsyncThunk["rejected"]>; type FulfilledAction = ReturnType<GenericAsyncThunk["fulfilled"]>; const initialState: Record<string, string> = {}; const resetAction = createAction("reset-tracked-loading-state"); function isPendingAction(action: UnknownAction): action is PendingAction { return typeof action.type === "string" && action.type.endsWith("/pending"); } const reducer = createReducer(initialState, (builder) => { builder .addCase(resetAction, () => initialState) // matcher can be defined outside as a type predicate function .addMatcher(isPendingAction, (state, action) => { state[action.meta.requestId] = "pending"; }) .addMatcher( // matcher can be defined inline as a type predicate function (action): action is RejectedAction => action.type.endsWith("/rejected"), (state, action) => { state[action.meta.requestId] = "rejected"; } ) // matcher can just return boolean and the matcher can receive a generic argument .addMatcher<FulfilledAction>( (action) => action.type.endsWith("/fulfilled"), (state, action) => { state[action.meta.requestId] = "fulfilled"; } ); }); ``` */ addMatcher<A>(matcher: TypeGuard<A> | ((action: any) => boolean), reducer: CaseReducer<State, A extends Action ? A : A & Action>): Omit<ActionReducerMapBuilder<State>, 'addCase'>; /** * Adds a "default case" reducer that is executed if no case reducer and no matcher * reducer was executed for this action. * @param reducer - The fallback "default case" reducer function. * * @example ```ts import { createReducer } from '@reduxjs/toolkit' const initialState = { otherActions: 0 } const reducer = createReducer(initialState, builder => { builder // .addCase(...) // .addMatcher(...) .addDefaultCase((state, action) => { state.otherActions++ }) }) ``` */ addDefaultCase(reducer: CaseReducer<State, Action>): {}; } /** * Defines a mapping from action types to corresponding action object shapes. * * @deprecated This should not be used manually - it is only used for internal * inference purposes and should not have any further value. * It might be removed in the future. * @public */ type Actions<T extends keyof any = string> = Record<T, Action>; /** * A *case reducer* is a reducer function for a specific action type. Case * reducers can be composed to full reducers using `createReducer()`. * * Unlike a normal Redux reducer, a case reducer is never called with an * `undefined` state to determine the initial state. Instead, the initial * state is explicitly specified as an argument to `createReducer()`. * * In addition, a case reducer can choose to mutate the passed-in `state` * value directly instead of returning a new state. This does not actually * cause the store state to be mutated directly; instead, thanks to * [immer](https://github.com/mweststrate/immer), the mutations are * translated to copy operations that result in a new state. * * @public */ type CaseReducer<S = any, A extends Action = UnknownAction> = (state: Draft<S>, action: A) => NoInfer<S> | void | Draft<NoInfer<S>>; /** * A mapping from action types to case reducers for `createReducer()`. * * @deprecated This should not be used manually - it is only used * for internal inference purposes and using it manually * would lead to type erasure. * It might be removed in the future. * @public */ type CaseReducers<S, AS extends Actions> = { [T in keyof AS]: AS[T] extends Action ? CaseReducer<S, AS[T]> : void; }; type NotFunction<T> = T extends Function ? never : T; type ReducerWithInitialState<S extends NotFunction<any>> = Reducer<S> & { getInitialState: () => S; }; /** * A utility function that allows defining a reducer as a mapping from action * type to *case reducer* functions that handle these action types. The * reducer's initial state is passed as the first argument. * * @remarks * The body of every case reducer is implicitly wrapped with a call to * `produce()` from the [immer](https://github.com/mweststrate/immer) library. * This means that rather than returning a new state object, you can also * mutate the passed-in state object directly; these mutations will then be * automatically and efficiently translated into copies, giving you both * convenience and immutability. * * @overloadSummary * This function accepts a callback that receives a `builder` object as its argument. * That builder provides `addCase`, `addMatcher` and `addDefaultCase` functions that may be * called to define what actions this reducer will handle. * * @param initialState - `State | (() => State)`: The initial state that should be used when the reducer is called the first time. This may also be a "lazy initializer" function, which should return an initial state value when called. This will be used whenever the reducer is called with `undefined` as its state value, and is primarily useful for cases like reading initial state from `localStorage`. * @param builderCallback - `(builder: Builder) => void` A callback that receives a *builder* object to define * case reducers via calls to `builder.addCase(actionCreatorOrType, reducer)`. * @example ```ts import { createAction, createReducer, UnknownAction, PayloadAction, } from "@reduxjs/toolkit"; const increment = createAction<number>("increment"); const decrement = createAction<number>("decrement"); function isActionWithNumberPayload( action: UnknownAction ): action is PayloadAction<number> { return typeof action.payload === "number"; } const reducer = createReducer( { counter: 0, sumOfNumberPayloads: 0, unhandledActions: 0, }, (builder) => { builder .addCase(increment, (state, action) => { // action is inferred correctly here state.counter += action.payload; }) // You can chain calls, or have separate `builder.addCase()` lines each time .addCase(decrement, (state, action) => { state.counter -= action.payload; }) // You can apply a "matcher function" to incoming actions .addMatcher(isActionWithNumberPayload, (state, action) => {}) // and provide a default case if no other handlers matched .addDefaultCase((state, action) => {}); } ); ``` * @public */ declare function createReducer<S extends NotFunction<any>>(initialState: S | (() => S), mapOrBuilderCallback: (builder: ActionReducerMapBuilder<S>) => void): ReducerWithInitialState<S>; type SliceLike<ReducerPath extends string, State> = { reducerPath: ReducerPath; reducer: Reducer<State>; }; type AnySliceLike = SliceLike<string, any>; type SliceLikeReducerPath<A extends AnySliceLike> = A extends SliceLike<infer ReducerPath, any> ? ReducerPath : never; type SliceLikeState<A extends AnySliceLike> = A extends SliceLike<any, infer State> ? State : never; type WithSlice<A extends AnySliceLike> = { [Path in SliceLikeReducerPath<A>]: SliceLikeState<A>; }; type ReducerMap = Record<string, Reducer>; type ExistingSliceLike<DeclaredState> = { [ReducerPath in keyof DeclaredState]: SliceLike<ReducerPath & string, NonUndefined<DeclaredState[ReducerPath]>>; }[keyof DeclaredState]; type InjectConfig = { /** * Allow replacing reducer with a different reference. Normally, an error will be thrown if a different reducer instance to the one already injected is used. */ overrideExisting?: boolean; }; /** * A reducer that allows for slices/reducers to be injected after initialisation. */ interface CombinedSliceReducer<InitialState, DeclaredState = InitialState> extends Reducer<DeclaredState, UnknownAction, Partial<DeclaredState>> { /** * Provide a type for slices that will be injected lazily. * * One way to do this would be with interface merging: * ```ts * * export interface LazyLoadedSlices {} * * export const rootReducer = combineSlices(stringSlice).withLazyLoadedSlices<LazyLoadedSlices>(); * * // elsewhere * * declare module './reducer' { * export interface LazyLoadedSlices extends WithSlice<typeof booleanSlice> {} * } * * const withBoolean = rootReducer.inject(booleanSlice); * * // elsewhere again * * declare module './reducer' { * export interface LazyLoadedSlices { * customName: CustomState * } * } * * const withCustom = rootReducer.inject({ reducerPath: "customName", reducer: customSlice.reducer }) * ``` */ withLazyLoadedSlices<Lazy = {}>(): CombinedSliceReducer<InitialState, Id<DeclaredState & Partial<Lazy>>>; /** * Inject a slice. * * Accepts an individual slice, RTKQ API instance, or a "slice-like" { reducerPath, reducer } object. * * ```ts * rootReducer.inject(booleanSlice) * rootReducer.inject(baseApi) * rootReducer.inject({ reducerPath: 'boolean' as const, reducer: newReducer }, { overrideExisting: true }) * ``` * */ inject<Sl extends Id<ExistingSliceLike<DeclaredState>>>(slice: Sl, config?: InjectConfig): CombinedSliceReducer<InitialState, Id<DeclaredState & WithSlice<Sl>>>; /** * Inject a slice. * * Accepts an individual slice, RTKQ API instance, or a "slice-like" { reducerPath, reducer } object. * * ```ts * rootReducer.inject(booleanSlice) * rootReducer.inject(baseApi) * rootReducer.inject({ reducerPath: 'boolean' as const, reducer: newReducer }, { overrideExisting: true }) * ``` * */ inject<ReducerPath extends string, State>(slice: SliceLike<ReducerPath, State & (ReducerPath extends keyof DeclaredState ? never : State)>, config?: InjectConfig): CombinedSliceReducer<InitialState, Id<DeclaredState & WithSlice<SliceLike<ReducerPath, State>>>>; /** * Create a selector that guarantees that the slices injected will have a defined value when selector is run. * * ```ts * const selectBooleanWithoutInjection = (state: RootState) => state.boolean; * // ^? boolean | undefined * * const selectBoolean = rootReducer.inject(booleanSlice).selector((state) => { * // if action hasn't been dispatched since slice was injected, this would usually be undefined * // however selector() uses a Proxy around the first parameter to ensure that it evaluates to the initial state instead, if undefined * return state.boolean; * // ^? boolean * }) * ``` * * If the reducer is nested inside the root state, a selectState callback can be passed to retrieve the reducer's state. * * ```ts * * export interface LazyLoadedSlices {}; * * export const innerReducer = combineSlices(stringSlice).withLazyLoadedSlices<LazyLoadedSlices>(); * * export const rootReducer = combineSlices({ inner: innerReducer }); * * export type RootState = ReturnType<typeof rootReducer>; * * // elsewhere * * declare module "./reducer.ts" { * export interface LazyLoadedSlices extends WithSlice<typeof booleanSlice> {} * } * * const withBool = innerReducer.inject(booleanSlice); * * const selectBoolean = withBool.selector( * (state) => state.boolean, * (rootState: RootState) => state.inner * ); * // now expects to be passed RootState instead of innerReducer state * * ``` * * Value passed to selectorFn will be a Proxy - use selector.original(proxy) to get original state value (useful for debugging) * * ```ts * const injectedReducer = rootReducer.inject(booleanSlice); * const selectBoolean = injectedReducer.selector((state) => { * console.log(injectedReducer.selector.original(state).boolean) // possibly undefined * return state.boolean * }) * ``` */ selector: { /** * Create a selector that guarantees that the slices injected will have a defined value when selector is run. * * ```ts * const selectBooleanWithoutInjection = (state: RootState) => state.boolean; * // ^? boolean | undefined * * const selectBoolean = rootReducer.inject(booleanSlice).selector((state) => { * // if action hasn't been dispatched since slice was injected, this would usually be undefined * // however selector() uses a Proxy around the first parameter to ensure that it evaluates to the initial state instead, if undefined * return state.boolean; * // ^? boolean * }) * ``` * * Value passed to selectorFn will be a Proxy - use selector.original(proxy) to get original state value (useful for debugging) * * ```ts * const injectedReducer = rootReducer.inject(booleanSlice); * const selectBoolean = injectedReducer.selector((state) => { * console.log(injectedReducer.selector.original(state).boolean) // undefined * return state.boolean * }) * ``` */ <Selector extends (state: DeclaredState, ...args: any[]) => unknown>(selectorFn: