@reduxjs/toolkit
Version:
The official, opinionated, batteries-included toolset for efficient Redux development
47 lines (46 loc) • 2.65 kB
TypeScript
import type { AnyAction } from '@reduxjs/toolkit';
import type { CombinedState as CombinedQueryState, QuerySubstateIdentifier, MutationSubstateIdentifier, Subscribers, ConfigState } from './apiState';
import type { MutationThunk, QueryThunk } from './buildThunks';
import type { AssertTagTypes, EndpointDefinitions } from '../endpointDefinitions';
import type { Patch } from 'immer';
import type { ApiContext } from '../apiTypes';
export declare function getMutationCacheKey(id: MutationSubstateIdentifier | {
requestId: string;
arg: {
fixedCacheKey?: string | undefined;
};
}): string;
export declare function getMutationCacheKey(id: {
fixedCacheKey?: string;
requestId?: string;
}): string | undefined;
export declare function buildSlice({ reducerPath, queryThunk, mutationThunk, context: { endpointDefinitions: definitions, apiUid, extractRehydrationInfo, hasRehydrationInfo, }, assertTagType, config, }: {
reducerPath: string;
queryThunk: QueryThunk;
mutationThunk: MutationThunk;
context: ApiContext<EndpointDefinitions>;
assertTagType: AssertTagTypes;
config: Omit<ConfigState<string>, 'online' | 'focused' | 'middlewareRegistered'>;
}): {
reducer: import("redux").Reducer<import("redux").CombinedState<CombinedQueryState<any, string, string>>, AnyAction>;
actions: {
/** @deprecated has been renamed to `removeMutationResult` */
unsubscribeMutationResult: import("@reduxjs/toolkit").ActionCreatorWithPayload<MutationSubstateIdentifier, string>;
resetApiState: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
removeMutationResult: import("@reduxjs/toolkit").ActionCreatorWithPayload<MutationSubstateIdentifier, string>;
updateSubscriptionOptions: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
endpointName: string;
requestId: string;
options: Subscribers[number];
} & QuerySubstateIdentifier, string>;
unsubscribeQueryResult: import("@reduxjs/toolkit").ActionCreatorWithPayload<{
requestId: string;
} & QuerySubstateIdentifier, string>;
removeQueryResult: import("@reduxjs/toolkit").ActionCreatorWithPayload<QuerySubstateIdentifier, string>;
queryResultPatched: import("@reduxjs/toolkit").ActionCreatorWithPayload<QuerySubstateIdentifier & {
patches: readonly Patch[];
}, string>;
middlewareRegistered: import("@reduxjs/toolkit").ActionCreatorWithPayload<string, string>;
};
};
export declare type SliceActions = ReturnType<typeof buildSlice>['actions'];