Skip to content

Instantly share code, notes, and snippets.

@phryneas

phryneas/index.md

Last active April 24, 2020 16:11
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save phryneas/59d65ba46cc733def86f37d96dee9a52 to your computer and use it in GitHub Desktop.
Save phryneas/59d65ba46cc733def86f37d96dee9a52 to your computer and use it in GitHub Desktop.
Download ZIP
api-documenter test
Raw
index.md
Raw
toolkit.actioncreatorwithnoninferrablepayload.md

Home > @reduxjs/toolkit > ActionCreatorWithNonInferrablePayload

ActionCreatorWithNonInferrablePayload interface

An action creator of type T whose payload type could not be inferred. Accepts everything as payload.

{redux#ActionCreator}

Signature:

export interface ActionCreatorWithNonInferrablePayload<T extends string = string> extends BaseActionCreator<unknown, T>
Raw
toolkit.actioncreatorwithoptionalpayload.md

Home > @reduxjs/toolkit > ActionCreatorWithOptionalPayload

ActionCreatorWithOptionalPayload interface

An action creator of type T that takes an optional payload of type P.

{redux#ActionCreator}

Signature:

export interface ActionCreatorWithOptionalPayload<P, T extends string = string> extends BaseActionCreator<P, T>
Raw
toolkit.actioncreatorwithoutpayload.md

Home > @reduxjs/toolkit > ActionCreatorWithoutPayload

ActionCreatorWithoutPayload interface

An action creator of type T that takes no payload.

{redux#ActionCreator}

Signature:

export interface ActionCreatorWithoutPayload<T extends string = string> extends BaseActionCreator<undefined, T>
Raw
toolkit.actioncreatorwithpayload.md

Home > @reduxjs/toolkit > ActionCreatorWithPayload

ActionCreatorWithPayload interface

An action creator of type T that requires a payload of type P.

{redux#ActionCreator}

Signature:

export interface ActionCreatorWithPayload<P, T extends string = string> extends BaseActionCreator<P, T>
Raw
toolkit.actioncreatorwithpreparedpayload.md

Home > @reduxjs/toolkit > ActionCreatorWithPreparedPayload

ActionCreatorWithPreparedPayload interface

An action creator that takes multiple arguments that are passed to a PrepareAction method to create the final Action.

Signature:

export interface ActionCreatorWithPreparedPayload<Args extends unknown[], P, T extends string = string, E = never, M = never> extends BaseActionCreator<P, T, M, E>
Raw
toolkit.actionreducermapbuilder.addcase.md

Home > @reduxjs/toolkit > ActionReducerMapBuilder > addCase

ActionReducerMapBuilder.addCase() method

Add a case reducer for actions created by this action creator.

Signature:

addCase<ActionCreator extends TypedActionCreator<string>>(actionCreator: ActionCreator, reducer: CaseReducer<State, ReturnType<ActionCreator>>): ActionReducerMapBuilder<State>;

Parameters

Parameter Type Description
actionCreator ActionCreator
reducer CaseReducer<State, ReturnType<ActionCreator>>

Returns:

ActionReducerMapBuilder<State>

Raw
toolkit.actionreducermapbuilder.addcase_1.md

Home > @reduxjs/toolkit > ActionReducerMapBuilder > addCase

ActionReducerMapBuilder.addCase() method

Add a case reducer for actions with the specified type.

Signature:

addCase<Type extends string, A extends Action<Type>>(type: Type, reducer: CaseReducer<State, A>): ActionReducerMapBuilder<State>;

Parameters

Parameter Type Description
type Type
reducer CaseReducer<State, A>

Returns:

ActionReducerMapBuilder<State>

Raw
toolkit.actionreducermapbuilder.md
Raw
toolkit.actions.md

Home > @reduxjs/toolkit > Actions

Actions type

Warning: This API is now obsolete.

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.

Defines a mapping from action types to corresponding action object shapes.

Signature:

export declare type Actions<T extends keyof any = string> = Record<T, Action>;
Raw
toolkit.api.json
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.7.0",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@reduxjs/toolkit!",
"docComment": "",
"name": "@reduxjs/toolkit",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@reduxjs/toolkit!",
"name": "",
"members": [
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithNonInferrablePayload:interface",
"docComment": "/**\n * An action creator of type `T` whose `payload` type could not be inferred. Accepts everything as `payload`.\n *\n * @inheritdoc {redux#ActionCreator}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ActionCreatorWithNonInferrablePayload<T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "BaseActionCreator",
"canonicalReference": "@reduxjs/toolkit!~BaseActionCreator:interface"
},
{
"kind": "Content",
"text": "<unknown, T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "ActionCreatorWithNonInferrablePayload",
"members": [
{
"kind": "CallSignature",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithNonInferrablePayload:call(1)",
"docComment": "/**\n * 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.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "<PT extends "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">(payload: "
},
{
"kind": "Content",
"text": "PT"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<PT, T>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "payload",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"typeParameters": [
{
"typeParameterName": "PT",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
]
}
],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 7
}
]
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithOptionalPayload:interface",
"docComment": "/**\n * An action creator of type `T` that takes an optional payload of type `P`.\n *\n * @inheritdoc {redux#ActionCreator}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ActionCreatorWithOptionalPayload<P, T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "BaseActionCreator",
"canonicalReference": "@reduxjs/toolkit!~BaseActionCreator:interface"
},
{
"kind": "Content",
"text": "<P, T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "ActionCreatorWithOptionalPayload",
"members": [
{
"kind": "CallSignature",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithOptionalPayload:call(1)",
"docComment": "/**\n * 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`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "(payload?: "
},
{
"kind": "Content",
"text": "P"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<P, T>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "payload",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
}
],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 7
}
]
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithoutPayload:interface",
"docComment": "/**\n * An action creator of type `T` that takes no payload.\n *\n * @inheritdoc {redux#ActionCreator}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ActionCreatorWithoutPayload<T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "BaseActionCreator",
"canonicalReference": "@reduxjs/toolkit!~BaseActionCreator:interface"
},
{
"kind": "Content",
"text": "<undefined, T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "ActionCreatorWithoutPayload",
"members": [
{
"kind": "CallSignature",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithoutPayload:call(1)",
"docComment": "/**\n * Calling this {@link redux#ActionCreator} will return a {@link PayloadAction} of type `T` with a payload of `undefined`\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<undefined, T>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": []
}
],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 7
}
]
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPayload:interface",
"docComment": "/**\n * An action creator of type `T` that requires a payload of type P.\n *\n * @inheritdoc {redux#ActionCreator}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ActionCreatorWithPayload<P, T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "BaseActionCreator",
"canonicalReference": "@reduxjs/toolkit!~BaseActionCreator:interface"
},
{
"kind": "Content",
"text": "<P, T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "ActionCreatorWithPayload",
"members": [
{
"kind": "CallSignature",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPayload:call(1)",
"docComment": "/**\n * Calling this {@link redux#ActionCreator} with an argument will return a {@link PayloadAction} of type `T` with a payload of `P`\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "(payload: "
},
{
"kind": "Content",
"text": "P"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<P, T>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "payload",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
}
],
"extendsTokenRanges": [
{
"startIndex": 5,
"endIndex": 7
}
]
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPreparedPayload:interface",
"docComment": "/**\n * An action creator that takes multiple arguments that are passed to a `PrepareAction` method to create the final Action.\n *\n * @typeParam - Args arguments for the action creator function\n *\n * @typeParam - P `payload` type\n *\n * @typeParam - T `type` name\n *\n * @typeParam - E optional `error` type\n *\n * @typeParam - M optional `meta` type\n *\n * @inheritdoc {redux#ActionCreator}\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ActionCreatorWithPreparedPayload<Args extends "
},
{
"kind": "Content",
"text": "unknown[]"
},
{
"kind": "Content",
"text": ", P, T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", E = "
},
{
"kind": "Content",
"text": "never"
},
{
"kind": "Content",
"text": ", M = "
},
{
"kind": "Content",
"text": "never"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "BaseActionCreator",
"canonicalReference": "@reduxjs/toolkit!~BaseActionCreator:interface"
},
{
"kind": "Content",
"text": "<P, T, M, E> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "Args",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"typeParameterName": "E",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
},
{
"typeParameterName": "M",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"name": "ActionCreatorWithPreparedPayload",
"members": [
{
"kind": "CallSignature",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPreparedPayload:call(1)",
"docComment": "/**\n * 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.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "(...args: "
},
{
"kind": "Content",
"text": "Args"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<P, T, M, E>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "args",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
}
],
"extendsTokenRanges": [
{
"startIndex": 11,
"endIndex": 13
}
]
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ActionReducerMapBuilder:interface",
"docComment": "/**\n * A builder for an action <-> reducer map.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ActionReducerMapBuilder<State> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "ActionReducerMapBuilder",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!ActionReducerMapBuilder#addCase:member(1)",
"docComment": "/**\n * Add a case reducer for actions created by this action creator.\n *\n * @param - actionCreator\n *\n * @param - reducer\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addCase<ActionCreator extends "
},
{
"kind": "Reference",
"text": "TypedActionCreator",
"canonicalReference": "@reduxjs/toolkit!TypedActionCreator:interface"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ">(actionCreator: "
},
{
"kind": "Content",
"text": "ActionCreator"
},
{
"kind": "Content",
"text": ", reducer: "
},
{
"kind": "Reference",
"text": "CaseReducer",
"canonicalReference": "@reduxjs/toolkit!CaseReducer:type"
},
{
"kind": "Content",
"text": "<State, "
},
{
"kind": "Reference",
"text": "ReturnType",
"canonicalReference": "!ReturnType:type"
},
{
"kind": "Content",
"text": "<ActionCreator>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ActionReducerMapBuilder",
"canonicalReference": "@reduxjs/toolkit!ActionReducerMapBuilder:interface"
},
{
"kind": "Content",
"text": "<State>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "actionCreator",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "reducer",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 10
}
}
],
"typeParameters": [
{
"typeParameterName": "ActionCreator",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "addCase"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!ActionReducerMapBuilder#addCase:member(2)",
"docComment": "/**\n * Add a case reducer for actions with the specified type.\n *\n * @param - type\n *\n * @param - reducer\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "addCase<Type extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", A extends "
},
{
"kind": "Reference",
"text": "Action",
"canonicalReference": "redux!Action:interface"
},
{
"kind": "Content",
"text": "<Type>"
},
{
"kind": "Content",
"text": ">(type: "
},
{
"kind": "Content",
"text": "Type"
},
{
"kind": "Content",
"text": ", reducer: "
},
{
"kind": "Reference",
"text": "CaseReducer",
"canonicalReference": "@reduxjs/toolkit!CaseReducer:type"
},
{
"kind": "Content",
"text": "<State, A>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ActionReducerMapBuilder",
"canonicalReference": "@reduxjs/toolkit!ActionReducerMapBuilder:interface"
},
{
"kind": "Content",
"text": "<State>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "type",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
},
{
"parameterName": "reducer",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 10
}
}
],
"typeParameters": [
{
"typeParameterName": "Type",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "A",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "addCase"
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!Actions:type",
"docComment": "/**\n * Defines a mapping from action types to corresponding action object shapes.\n *\n * @deprecated\n *\n * 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.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type Actions<T extends "
},
{
"kind": "Content",
"text": "keyof any "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<T, "
},
{
"kind": "Reference",
"text": "Action",
"canonicalReference": "redux!Action:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Actions",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"typeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkAction:type",
"docComment": "/**\n * A ThunkAction created by `createAsyncThunk`. Dispatching it returns a Promise for either a fulfilled or rejected action. Also, the returned value contains a `abort()` method that allows the asyncAction to be cancelled from the outside.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig extends "
},
{
"kind": "Reference",
"text": "AsyncThunkConfig",
"canonicalReference": "@reduxjs/toolkit!~AsyncThunkConfig:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "(dispatch: "
},
{
"kind": "Reference",
"text": "GetDispatch",
"canonicalReference": "@reduxjs/toolkit!~GetDispatch:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>, getState: () => "
},
{
"kind": "Reference",
"text": "GetState",
"canonicalReference": "@reduxjs/toolkit!~GetState:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>, extra: "
},
{
"kind": "Reference",
"text": "GetExtra",
"canonicalReference": "@reduxjs/toolkit!~GetExtra:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>) => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<Returned, string, {\n arg: ThunkArg;\n requestId: string;\n}> | "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<undefined | "
},
{
"kind": "Reference",
"text": "GetRejectValue",
"canonicalReference": "@reduxjs/toolkit!~GetRejectValue:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>, string, {\n arg: ThunkArg;\n requestId: string;\n aborted: boolean;\n condition: boolean;\n}, "
},
{
"kind": "Reference",
"text": "SerializedError",
"canonicalReference": "@reduxjs/toolkit!SerializedError:interface"
},
{
"kind": "Content",
"text": ">> & {\n abort(reason?: string): void;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "AsyncThunkAction",
"typeParameters": [
{
"typeParameterName": "Returned",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "ThunkArg",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "ThunkApiConfig",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 20
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkPayloadCreator:type",
"docComment": "/**\n * A type describing the `payloadCreator` argument to `createAsyncThunk`. Might be useful for wrapping `createAsyncThunk` in custom abstractions.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type AsyncThunkPayloadCreator<Returned, ThunkArg = "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ", ThunkApiConfig extends "
},
{
"kind": "Reference",
"text": "AsyncThunkConfig",
"canonicalReference": "@reduxjs/toolkit!~AsyncThunkConfig:type"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "{}"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "(arg: ThunkArg, thunkAPI: "
},
{
"kind": "Reference",
"text": "GetThunkAPI",
"canonicalReference": "@reduxjs/toolkit!~GetThunkAPI:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>) => "
},
{
"kind": "Reference",
"text": "AsyncThunkPayloadCreatorReturnValue",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkPayloadCreatorReturnValue:type"
},
{
"kind": "Content",
"text": "<Returned, ThunkApiConfig>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "AsyncThunkPayloadCreator",
"typeParameters": [
{
"typeParameterName": "Returned",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "ThunkArg",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "ThunkApiConfig",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
}
],
"typeTokenRange": {
"startIndex": 8,
"endIndex": 13
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkPayloadCreatorReturnValue:type",
"docComment": "/**\n * A type describing the return value of the `payloadCreator` argument to `createAsyncThunk`. Might be useful for wrapping `createAsyncThunk` in custom abstractions.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type AsyncThunkPayloadCreatorReturnValue<Returned, ThunkApiConfig extends "
},
{
"kind": "Reference",
"text": "AsyncThunkConfig",
"canonicalReference": "@reduxjs/toolkit!~AsyncThunkConfig:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<Returned | "
},
{
"kind": "Reference",
"text": "RejectWithValue",
"canonicalReference": "@reduxjs/toolkit!~RejectWithValue:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "GetRejectValue",
"canonicalReference": "@reduxjs/toolkit!~GetRejectValue:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>>> | Returned | "
},
{
"kind": "Reference",
"text": "RejectWithValue",
"canonicalReference": "@reduxjs/toolkit!~RejectWithValue:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "GetRejectValue",
"canonicalReference": "@reduxjs/toolkit!~GetRejectValue:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "AsyncThunkPayloadCreatorReturnValue",
"typeParameters": [
{
"typeParameterName": "Returned",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "ThunkApiConfig",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 13
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!CaseReducer:type",
"docComment": "/**\n * An *case reducer* is a reducer function for a specific action type. Case reducers can be composed to full reducers using `createReducer()`.\n *\n * 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()`.\n *\n * 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.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type CaseReducer<S = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", A extends "
},
{
"kind": "Reference",
"text": "Action",
"canonicalReference": "redux!Action:interface"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "AnyAction",
"canonicalReference": "redux!AnyAction:interface"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "(state: "
},
{
"kind": "Reference",
"text": "Draft",
"canonicalReference": "immer!Draft:type"
},
{
"kind": "Content",
"text": "<S>, action: A) => S | void"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CaseReducer",
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "A",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
}
],
"typeTokenRange": {
"startIndex": 8,
"endIndex": 11
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!CaseReducerActions:type",
"docComment": "/**\n * Derives the slice's `actions` property from the `reducers` options\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type CaseReducerActions<CaseReducers extends "
},
{
"kind": "Reference",
"text": "SliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "{\n [Type in keyof CaseReducers]: CaseReducers[Type] extends {\n prepare: any;\n } ? "
},
{
"kind": "Reference",
"text": "ActionCreatorForCaseReducerWithPrepare",
"canonicalReference": "@reduxjs/toolkit!~ActionCreatorForCaseReducerWithPrepare:type"
},
{
"kind": "Content",
"text": "<CaseReducers[Type]> : "
},
{
"kind": "Reference",
"text": "ActionCreatorForCaseReducer",
"canonicalReference": "@reduxjs/toolkit!~ActionCreatorForCaseReducer:type"
},
{
"kind": "Content",
"text": "<CaseReducers[Type]>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CaseReducerActions",
"typeParameters": [
{
"typeParameterName": "CaseReducers",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 4,
"endIndex": 9
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!CaseReducers:type",
"docComment": "/**\n * A mapping from action types to case reducers for `createReducer()`.\n *\n * @deprecated\n *\n * 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.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type CaseReducers<S, AS extends "
},
{
"kind": "Reference",
"text": "Actions",
"canonicalReference": "@reduxjs/toolkit!Actions:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "{\n [T in keyof AS]: AS[T] extends "
},
{
"kind": "Reference",
"text": "Action",
"canonicalReference": "redux!Action:interface"
},
{
"kind": "Content",
"text": " ? "
},
{
"kind": "Reference",
"text": "CaseReducer",
"canonicalReference": "@reduxjs/toolkit!CaseReducer:type"
},
{
"kind": "Content",
"text": "<S, AS[T]> : void;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CaseReducers",
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "AS",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 8
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!CaseReducerWithPrepare:type",
"docComment": "/**\n * A CaseReducer with a `prepare` method.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type CaseReducerWithPrepare<State, Action extends "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "{\n reducer: "
},
{
"kind": "Reference",
"text": "CaseReducer",
"canonicalReference": "@reduxjs/toolkit!CaseReducer:type"
},
{
"kind": "Content",
"text": "<State, Action>;\n prepare: "
},
{
"kind": "Reference",
"text": "PrepareAction",
"canonicalReference": "@reduxjs/toolkit!PrepareAction:type"
},
{
"kind": "Content",
"text": "<Action['payload']>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "CaseReducerWithPrepare",
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Action",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 3,
"endIndex": 8
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!Comparer:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type Comparer<T> = "
},
{
"kind": "Content",
"text": "(a: T, b: T) => number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Comparer",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!ConfigureEnhancersCallback:type",
"docComment": "/**\n * Callback function type, to be used in `ConfigureStoreOptions.enhancers`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type ConfigureEnhancersCallback = "
},
{
"kind": "Content",
"text": "(defaultEnhancers: "
},
{
"kind": "Reference",
"text": "StoreEnhancer",
"canonicalReference": "redux!StoreEnhancer:type"
},
{
"kind": "Content",
"text": "[]) => "
},
{
"kind": "Reference",
"text": "StoreEnhancer",
"canonicalReference": "redux!StoreEnhancer:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ConfigureEnhancersCallback",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!configureStore:function(1)",
"docComment": "/**\n * A friendly abstraction over the standard Redux `createStore()` function.\n *\n * @param - config The store configuration.\n *\n * @returns A configured Redux store.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function configureStore<S = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", A extends "
},
{
"kind": "Reference",
"text": "Action",
"canonicalReference": "redux!Action:interface"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "AnyAction",
"canonicalReference": "redux!AnyAction:interface"
},
{
"kind": "Content",
"text": ", M extends "
},
{
"kind": "Reference",
"text": "Middlewares",
"canonicalReference": "@reduxjs/toolkit!~Middlewares:type"
},
{
"kind": "Content",
"text": "<S> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "ThunkMiddlewareFor",
"canonicalReference": "@reduxjs/toolkit!ThunkMiddlewareFor:type"
},
{
"kind": "Content",
"text": "<S>]"
},
{
"kind": "Content",
"text": ">(options: "
},
{
"kind": "Reference",
"text": "ConfigureStoreOptions",
"canonicalReference": "@reduxjs/toolkit!ConfigureStoreOptions:interface"
},
{
"kind": "Content",
"text": "<S, A, M>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "EnhancedStore",
"canonicalReference": "@reduxjs/toolkit!EnhancedStore:interface"
},
{
"kind": "Content",
"text": "<S, A, M>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 18,
"endIndex": 20
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 15,
"endIndex": 17
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "A",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
},
{
"typeParameterName": "M",
"constraintTokenRange": {
"startIndex": 8,
"endIndex": 10
},
"defaultTypeTokenRange": {
"startIndex": 11,
"endIndex": 14
}
}
],
"name": "configureStore"
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ConfigureStoreOptions:interface",
"docComment": "/**\n * Options for `configureStore()`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ConfigureStoreOptions<S = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", A extends "
},
{
"kind": "Reference",
"text": "Action",
"canonicalReference": "redux!Action:interface"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "AnyAction",
"canonicalReference": "redux!AnyAction:interface"
},
{
"kind": "Content",
"text": ", M extends "
},
{
"kind": "Reference",
"text": "Middlewares",
"canonicalReference": "@reduxjs/toolkit!~Middlewares:type"
},
{
"kind": "Content",
"text": "<S> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "Middlewares",
"canonicalReference": "@reduxjs/toolkit!~Middlewares:type"
},
{
"kind": "Content",
"text": "<S>"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "A",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
},
{
"typeParameterName": "M",
"constraintTokenRange": {
"startIndex": 8,
"endIndex": 10
},
"defaultTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
}
}
],
"name": "ConfigureStoreOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ConfigureStoreOptions#devTools:member",
"docComment": "/**\n * Whether to enable Redux DevTools integration. Defaults to `true`.\n *\n * Additional configuration can be done by passing Redux DevTools options\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "devTools?: "
},
{
"kind": "Content",
"text": "boolean | "
},
{
"kind": "Reference",
"text": "DevToolsOptions",
"canonicalReference": "@reduxjs/toolkit!EnhancerOptions:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "devTools",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ConfigureStoreOptions#enhancers:member",
"docComment": "/**\n * 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 the original array (ie, `[applyMiddleware]`), and should return a new array (such as `[applyMiddleware, offline]`). If you only need to add middleware, you can use the `middleware` parameter instaead.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "enhancers?: "
},
{
"kind": "Reference",
"text": "StoreEnhancer",
"canonicalReference": "redux!StoreEnhancer:type"
},
{
"kind": "Content",
"text": "[] | "
},
{
"kind": "Reference",
"text": "ConfigureEnhancersCallback",
"canonicalReference": "@reduxjs/toolkit!ConfigureEnhancersCallback:type"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "enhancers",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ConfigureStoreOptions#middleware:member",
"docComment": "/**\n * An array of Redux middleware to install. If not supplied, defaults to the set of middleware returned by `getDefaultMiddleware()`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "middleware?: "
},
{
"kind": "Content",
"text": "M"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "middleware",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ConfigureStoreOptions#preloadedState:member",
"docComment": "/**\n * 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.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "preloadedState?: "
},
{
"kind": "Reference",
"text": "DeepPartial",
"canonicalReference": "redux!DeepPartial:type"
},
{
"kind": "Content",
"text": "<S extends any ? S : S>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "preloadedState",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ConfigureStoreOptions#reducer:member",
"docComment": "/**\n * A single reducer function that will be used as the root reducer, or an object of slice reducers that will be passed to `combineReducers()`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "reducer: "
},
{
"kind": "Reference",
"text": "Reducer",
"canonicalReference": "redux!Reducer:type"
},
{
"kind": "Content",
"text": "<S, A> | "
},
{
"kind": "Reference",
"text": "ReducersMapObject",
"canonicalReference": "redux!ReducersMapObject:type"
},
{
"kind": "Content",
"text": "<S, A>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "reducer",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createAction:function(1)",
"docComment": "/**\n * 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() overriden so that it returns the action type, allowing it to be used in reducer logic that is looking for that action type.\n *\n * @param - type The action type to use for created actions.\n *\n * @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 it's arguments to this method to calculate payload & meta.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createAction<P = "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ", T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ">(type: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PayloadActionCreator",
"canonicalReference": "@reduxjs/toolkit!PayloadActionCreator:type"
},
{
"kind": "Content",
"text": "<P, T>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "type",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "createAction"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createAction:function(2)",
"docComment": "/**\n * 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() overriden so that it returns the action type, allowing it to be used in reducer logic that is looking for that action type.\n *\n * @param - type The action type to use for created actions.\n *\n * @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 it's arguments to this method to calculate payload & meta.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createAction<PA extends "
},
{
"kind": "Reference",
"text": "PrepareAction",
"canonicalReference": "@reduxjs/toolkit!PrepareAction:type"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ", T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ">(type: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ", prepareAction: "
},
{
"kind": "Content",
"text": "PA"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PayloadActionCreator",
"canonicalReference": "@reduxjs/toolkit!PayloadActionCreator:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "ReturnType",
"canonicalReference": "!ReturnType:type"
},
{
"kind": "Content",
"text": "<PA>['payload'], T, PA>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 16
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "type",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
},
{
"parameterName": "prepareAction",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
}
}
],
"typeParameters": [
{
"typeParameterName": "PA",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
}
],
"name": "createAction"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createAsyncThunk:function(1)",
"docComment": "/**\n * @param - type\n *\n * @param - payloadCreator\n *\n * @param - options\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createAsyncThunk<Returned, ThunkArg = "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ", ThunkApiConfig extends "
},
{
"kind": "Reference",
"text": "AsyncThunkConfig",
"canonicalReference": "@reduxjs/toolkit!~AsyncThunkConfig:type"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "{}"
},
{
"kind": "Content",
"text": ">(type: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", payloadCreator: "
},
{
"kind": "Content",
"text": "(arg: ThunkArg, thunkAPI: "
},
{
"kind": "Reference",
"text": "GetThunkAPI",
"canonicalReference": "@reduxjs/toolkit!~GetThunkAPI:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>) => "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<Returned | "
},
{
"kind": "Reference",
"text": "RejectWithValue",
"canonicalReference": "@reduxjs/toolkit!~RejectWithValue:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "GetRejectValue",
"canonicalReference": "@reduxjs/toolkit!~GetRejectValue:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>>> | Returned | "
},
{
"kind": "Reference",
"text": "RejectWithValue",
"canonicalReference": "@reduxjs/toolkit!~RejectWithValue:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "GetRejectValue",
"canonicalReference": "@reduxjs/toolkit!~GetRejectValue:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig>>"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "AsyncThunkOptions",
"canonicalReference": "@reduxjs/toolkit!~AsyncThunkOptions:interface"
},
{
"kind": "Content",
"text": "<ThunkArg, ThunkApiConfig>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "IsAny",
"canonicalReference": "@reduxjs/toolkit!IsAny:type"
},
{
"kind": "Content",
"text": "<ThunkArg, (arg: ThunkArg) => "
},
{
"kind": "Reference",
"text": "AsyncThunkAction",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkAction:type"
},
{
"kind": "Content",
"text": "<Returned, ThunkArg, ThunkApiConfig>, unknown extends ThunkArg ? (arg: ThunkArg) => "
},
{
"kind": "Reference",
"text": "AsyncThunkAction",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkAction:type"
},
{
"kind": "Content",
"text": "<Returned, ThunkArg, ThunkApiConfig> : [ThunkArg] extends [void] | [undefined] ? () => "
},
{
"kind": "Reference",
"text": "AsyncThunkAction",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkAction:type"
},
{
"kind": "Content",
"text": "<Returned, ThunkArg, ThunkApiConfig> : [void] extends [ThunkArg] ? (arg?: ThunkArg | undefined) => "
},
{
"kind": "Reference",
"text": "AsyncThunkAction",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkAction:type"
},
{
"kind": "Content",
"text": "<Returned, ThunkArg, ThunkApiConfig> : [undefined] extends [ThunkArg] ? (arg?: ThunkArg | undefined) => "
},
{
"kind": "Reference",
"text": "AsyncThunkAction",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkAction:type"
},
{
"kind": "Content",
"text": "<Returned, ThunkArg, ThunkApiConfig> : (arg: ThunkArg) => "
},
{
"kind": "Reference",
"text": "AsyncThunkAction",
"canonicalReference": "@reduxjs/toolkit!AsyncThunkAction:type"
},
{
"kind": "Content",
"text": "<Returned, ThunkArg, ThunkApiConfig>> & {\n pending: "
},
{
"kind": "Reference",
"text": "ActionCreatorWithPreparedPayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPreparedPayload:interface"
},
{
"kind": "Content",
"text": "<[string, ThunkArg], undefined, string, never, {\n arg: ThunkArg;\n requestId: string;\n }>;\n rejected: "
},
{
"kind": "Reference",
"text": "ActionCreatorWithPreparedPayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPreparedPayload:interface"
},
{
"kind": "Content",
"text": "<["
},
{
"kind": "Reference",
"text": "Error",
"canonicalReference": "!Error:interface"
},
{
"kind": "Content",
"text": " | null, string, ThunkArg, ("
},
{
"kind": "Reference",
"text": "GetRejectValue",
"canonicalReference": "@reduxjs/toolkit!~GetRejectValue:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig> | undefined)?], "
},
{
"kind": "Reference",
"text": "GetRejectValue",
"canonicalReference": "@reduxjs/toolkit!~GetRejectValue:type"
},
{
"kind": "Content",
"text": "<ThunkApiConfig> | undefined, string, "
},
{
"kind": "Reference",
"text": "SerializedError",
"canonicalReference": "@reduxjs/toolkit!SerializedError:interface"
},
{
"kind": "Content",
"text": ", {\n arg: ThunkArg;\n requestId: string;\n aborted: boolean;\n condition: boolean;\n }>;\n fulfilled: "
},
{
"kind": "Reference",
"text": "ActionCreatorWithPreparedPayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPreparedPayload:interface"
},
{
"kind": "Content",
"text": "<[Returned, string, ThunkArg], Returned, string, never, {\n arg: ThunkArg;\n requestId: string;\n }>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 27,
"endIndex": 55
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "type",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
},
{
"parameterName": "payloadCreator",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 23
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 24,
"endIndex": 26
}
}
],
"typeParameters": [
{
"typeParameterName": "Returned",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "ThunkArg",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "ThunkApiConfig",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
}
],
"name": "createAsyncThunk"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createEntityAdapter:function(1)",
"docComment": "/**\n * @param - options\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createEntityAdapter<T>(options?: "
},
{
"kind": "Content",
"text": "{\n selectId?: "
},
{
"kind": "Reference",
"text": "IdSelector",
"canonicalReference": "@reduxjs/toolkit!IdSelector:type"
},
{
"kind": "Content",
"text": "<T>;\n sortComparer?: false | "
},
{
"kind": "Reference",
"text": "Comparer",
"canonicalReference": "@reduxjs/toolkit!Comparer:type"
},
{
"kind": "Content",
"text": "<T>;\n}"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "EntityAdapter",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "createEntityAdapter"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createImmutableStateInvariantMiddleware:function(1)",
"docComment": "/**\n * 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.\n *\n * @param - options Middleware options.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createImmutableStateInvariantMiddleware(options?: "
},
{
"kind": "Reference",
"text": "ImmutableStateInvariantMiddlewareOptions",
"canonicalReference": "@reduxjs/toolkit!ImmutableStateInvariantMiddlewareOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Middleware",
"canonicalReference": "redux!Middleware:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "createImmutableStateInvariantMiddleware"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createReducer:function(1)",
"docComment": "/**\n * 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.\n *\n * 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.\n *\n * @param - initialState The initial state to be returned by the reducer.\n *\n * @param - actionsMap A mapping from action types to action-type-specific case reducers.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createReducer<S, CR extends "
},
{
"kind": "Reference",
"text": "CaseReducers",
"canonicalReference": "@reduxjs/toolkit!CaseReducers:type"
},
{
"kind": "Content",
"text": "<S, any> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "CaseReducers",
"canonicalReference": "@reduxjs/toolkit!CaseReducers:type"
},
{
"kind": "Content",
"text": "<S, any>"
},
{
"kind": "Content",
"text": ">(initialState: "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ", actionsMap: "
},
{
"kind": "Content",
"text": "CR"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Reducer",
"canonicalReference": "redux!Reducer:type"
},
{
"kind": "Content",
"text": "<S>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "initialState",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
},
{
"parameterName": "actionsMap",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "CR",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
}
],
"name": "createReducer"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createReducer:function(2)",
"docComment": "/**\n * 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.\n *\n * 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.\n *\n * @param - initialState The initial state to be returned by the reducer.\n *\n * @param - builderCallback A callback that receives a *builder* object to define case reducers via calls to `builder.addCase(actionCreatorOrType, reducer)`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createReducer<S>(initialState: "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ", builderCallback: "
},
{
"kind": "Content",
"text": "(builder: "
},
{
"kind": "Reference",
"text": "ActionReducerMapBuilder",
"canonicalReference": "@reduxjs/toolkit!ActionReducerMapBuilder:interface"
},
{
"kind": "Content",
"text": "<S>) => void"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Reducer",
"canonicalReference": "redux!Reducer:type"
},
{
"kind": "Content",
"text": "<S>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "initialState",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "builderCallback",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 6
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "createReducer"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createSerializableStateInvariantMiddleware:function(1)",
"docComment": "/**\n * 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.\n *\n * @param - options Middleware options.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createSerializableStateInvariantMiddleware(options?: "
},
{
"kind": "Reference",
"text": "SerializableStateInvariantMiddlewareOptions",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Middleware",
"canonicalReference": "redux!Middleware:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "createSerializableStateInvariantMiddleware"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!createSlice:function(1)",
"docComment": "/**\n * A function that accepts an initial state, an object full of reducer functions, and a \"slice name\", and automatically generates action creators and action types that correspond to the reducers and state.\n *\n * The `reducer` argument is passed to `createReducer()`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function createSlice<State, CaseReducers extends "
},
{
"kind": "Reference",
"text": "SliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<State>"
},
{
"kind": "Content",
"text": ", Name extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ">(options: "
},
{
"kind": "Reference",
"text": "CreateSliceOptions",
"canonicalReference": "@reduxjs/toolkit!CreateSliceOptions:interface"
},
{
"kind": "Content",
"text": "<State, CaseReducers, Name>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Slice",
"canonicalReference": "@reduxjs/toolkit!Slice:interface"
},
{
"kind": "Content",
"text": "<State, CaseReducers, Name>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 10
}
}
],
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "CaseReducers",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "Name",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
}
],
"name": "createSlice"
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!CreateSliceOptions:interface",
"docComment": "/**\n * Options for `createSlice()`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface CreateSliceOptions<State = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", CR extends "
},
{
"kind": "Reference",
"text": "SliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<State> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "SliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<State>"
},
{
"kind": "Content",
"text": ", Name extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "CR",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
}
},
{
"typeParameterName": "Name",
"constraintTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"defaultTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
}
],
"name": "CreateSliceOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!CreateSliceOptions#extraReducers:member",
"docComment": "/**\n * A mapping from action types to action-type-specific *case reducer* functions. These reducers should have existing action types used as the keys, and action creators will _not_ be generated. Alternatively, a callback that receives a *builder* object to define case reducers via calls to `builder.addCase(actionCreatorOrType, reducer)`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "extraReducers?: "
},
{
"kind": "Reference",
"text": "CaseReducers",
"canonicalReference": "@reduxjs/toolkit!CaseReducers:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NoInfer",
"canonicalReference": "@reduxjs/toolkit!~NoInfer:type"
},
{
"kind": "Content",
"text": "<State>, any> | ((builder: "
},
{
"kind": "Reference",
"text": "ActionReducerMapBuilder",
"canonicalReference": "@reduxjs/toolkit!ActionReducerMapBuilder:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "NoInfer",
"canonicalReference": "@reduxjs/toolkit!~NoInfer:type"
},
{
"kind": "Content",
"text": "<State>>) => void)"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "extraReducers",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 9
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!CreateSliceOptions#initialState:member",
"docComment": "/**\n * The initial state to be returned by the slice reducer.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "initialState: "
},
{
"kind": "Content",
"text": "State"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "initialState",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!CreateSliceOptions#name:member",
"docComment": "/**\n * The slice's name. Used to namespace the generated action types.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "name: "
},
{
"kind": "Content",
"text": "Name"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!CreateSliceOptions#reducers:member",
"docComment": "/**\n * A mapping from action types to action-type-specific *case reducer* functions. For every action type, a matching action creator will be generated using `createAction()`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "reducers: "
},
{
"kind": "Reference",
"text": "ValidateSliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!ValidateSliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<State, CR>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "reducers",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!Dictionary:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Dictionary<T> extends "
},
{
"kind": "Reference",
"text": "DictionaryNum",
"canonicalReference": "@reduxjs/toolkit!DictionaryNum:interface"
},
{
"kind": "Content",
"text": "<T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "Dictionary",
"members": [
{
"kind": "IndexSignature",
"canonicalReference": "@reduxjs/toolkit!Dictionary:index(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "[id: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "]: "
},
{
"kind": "Content",
"text": "T | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "id",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!EnhancedStore:interface",
"docComment": "/**\n * A Redux store returned by `configureStore()`. Supports dispatching side-effectful _thunks_ in addition to plain actions.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EnhancedStore<S = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", A extends "
},
{
"kind": "Reference",
"text": "Action",
"canonicalReference": "redux!Action:interface"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "AnyAction",
"canonicalReference": "redux!AnyAction:interface"
},
{
"kind": "Content",
"text": ", M extends "
},
{
"kind": "Reference",
"text": "Middlewares",
"canonicalReference": "@reduxjs/toolkit!~Middlewares:type"
},
{
"kind": "Content",
"text": "<S> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "Middlewares",
"canonicalReference": "@reduxjs/toolkit!~Middlewares:type"
},
{
"kind": "Content",
"text": "<S>"
},
{
"kind": "Content",
"text": "> extends "
},
{
"kind": "Reference",
"text": "Store",
"canonicalReference": "redux!Store:interface"
},
{
"kind": "Content",
"text": "<S, A> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "A",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
},
{
"typeParameterName": "M",
"constraintTokenRange": {
"startIndex": 8,
"endIndex": 10
},
"defaultTypeTokenRange": {
"startIndex": 11,
"endIndex": 13
}
}
],
"name": "EnhancedStore",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EnhancedStore#dispatch:member",
"docComment": "/**\n * The `dispatch` method of your store, enhanced by all it's middlewares.\n *\n * @inheritdoc\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "dispatch: "
},
{
"kind": "Reference",
"text": "DispatchForMiddlewares",
"canonicalReference": "@reduxjs/toolkit!DispatchForMiddlewares:type"
},
{
"kind": "Content",
"text": "<M> & "
},
{
"kind": "Reference",
"text": "Dispatch",
"canonicalReference": "redux!Dispatch:interface"
},
{
"kind": "Content",
"text": "<A>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dispatch",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
],
"extendsTokenRanges": [
{
"startIndex": 14,
"endIndex": 16
}
]
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EntityAdapter<T> extends "
},
{
"kind": "Reference",
"text": "EntityStateAdapter",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter:interface"
},
{
"kind": "Content",
"text": "<T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "EntityAdapter",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter#getInitialState:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getInitialState(): "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "getInitialState"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter#getInitialState:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getInitialState<S extends "
},
{
"kind": "Content",
"text": "object"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T> & S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "getInitialState"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter#getSelectors:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getSelectors(): "
},
{
"kind": "Reference",
"text": "EntitySelectors",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors:interface"
},
{
"kind": "Content",
"text": "<T, "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "getSelectors"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter#getSelectors:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "getSelectors<V>(selectState: "
},
{
"kind": "Content",
"text": "(state: V) => "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "EntitySelectors",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors:interface"
},
{
"kind": "Content",
"text": "<T, V>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "selectState",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
}
],
"typeParameters": [
{
"typeParameterName": "V",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "getSelectors"
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter#selectId:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "selectId: "
},
{
"kind": "Reference",
"text": "IdSelector",
"canonicalReference": "@reduxjs/toolkit!IdSelector:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "selectId",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntityAdapter#sortComparer:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "sortComparer: "
},
{
"kind": "Content",
"text": "false | "
},
{
"kind": "Reference",
"text": "Comparer",
"canonicalReference": "@reduxjs/toolkit!Comparer:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "sortComparer",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
}
],
"extendsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!EntityId:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type EntityId = "
},
{
"kind": "Content",
"text": "number | string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "EntityId",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EntitySelectors<T, V> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "V",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "EntitySelectors",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors#selectAll:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "selectAll: "
},
{
"kind": "Content",
"text": "(state: V) => T[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "selectAll",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors#selectById:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "selectById: "
},
{
"kind": "Content",
"text": "(state: V, id: "
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ") => T | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "selectById",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors#selectEntities:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "selectEntities: "
},
{
"kind": "Content",
"text": "(state: V) => "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@reduxjs/toolkit!Dictionary:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "selectEntities",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors#selectIds:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "selectIds: "
},
{
"kind": "Content",
"text": "(state: V) => "
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "selectIds",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntitySelectors#selectTotal:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "selectTotal: "
},
{
"kind": "Content",
"text": "(state: V) => number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "selectTotal",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EntityState<T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "EntityState",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntityState#entities:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "entities: "
},
{
"kind": "Reference",
"text": "Dictionary",
"canonicalReference": "@reduxjs/toolkit!Dictionary:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "entities",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!EntityState#ids:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "ids: "
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ids",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface EntityStateAdapter<T> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "EntityStateAdapter",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#addMany:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "addMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entities: "
},
{
"kind": "Content",
"text": "T[] | "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ", T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entities",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "addMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#addMany:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "addMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entities: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<T[] | "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ", T>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entities",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 13
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "addMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#addOne:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "addOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entity: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entity",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "addOne"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#addOne:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "addOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", action: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "action",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "addOne"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#removeAll:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "removeAll<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "removeAll"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#removeMany:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "removeMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", keys: "
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "keys",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "removeMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#removeMany:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "removeMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", keys: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": "[]>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "keys",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 11
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "removeMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#removeOne:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "removeOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", key: "
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "removeOne"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#removeOne:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "removeOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", key: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 11
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "removeOne"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#setAll:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "setAll<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entities: "
},
{
"kind": "Content",
"text": "T[] | "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ", T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entities",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "setAll"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#setAll:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "setAll<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entities: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<T[] | "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ", T>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entities",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 13
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "setAll"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#updateMany:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "updateMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", updates: "
},
{
"kind": "Reference",
"text": "Update",
"canonicalReference": "@reduxjs/toolkit!Update:type"
},
{
"kind": "Content",
"text": "<T>[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "updates",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "updateMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#updateMany:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "updateMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", updates: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Update",
"canonicalReference": "@reduxjs/toolkit!Update:type"
},
{
"kind": "Content",
"text": "<T>[]>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "updates",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 11
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "updateMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#updateOne:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "updateOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", update: "
},
{
"kind": "Reference",
"text": "Update",
"canonicalReference": "@reduxjs/toolkit!Update:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "update",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "updateOne"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#updateOne:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "updateOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", update: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Update",
"canonicalReference": "@reduxjs/toolkit!Update:type"
},
{
"kind": "Content",
"text": "<T>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "update",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 11
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "updateOne"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#upsertMany:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "upsertMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entities: "
},
{
"kind": "Content",
"text": "T[] | "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ", T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entities",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "upsertMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#upsertMany:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "upsertMany<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entities: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<T[] | "
},
{
"kind": "Reference",
"text": "Record",
"canonicalReference": "!Record:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ", T>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entities",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 13
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "upsertMany"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#upsertOne:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "upsertOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entity: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entity",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "upsertOne"
},
{
"kind": "MethodSignature",
"canonicalReference": "@reduxjs/toolkit!EntityStateAdapter#upsertOne:member(2)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "upsertOne<S extends "
},
{
"kind": "Reference",
"text": "EntityState",
"canonicalReference": "@reduxjs/toolkit!EntityState:interface"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": ">(state: "
},
{
"kind": "Reference",
"text": "PreventAny",
"canonicalReference": "@reduxjs/toolkit!PreventAny:type"
},
{
"kind": "Content",
"text": "<S, T>"
},
{
"kind": "Content",
"text": ", entity: "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "S"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "state",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
},
{
"parameterName": "entity",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "upsertOne"
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!findNonSerializableValue:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function findNonSerializableValue(value: "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ", path?: "
},
{
"kind": "Reference",
"text": "ReadonlyArray",
"canonicalReference": "!ReadonlyArray:interface"
},
{
"kind": "Content",
"text": "<string>"
},
{
"kind": "Content",
"text": ", isSerializable?: "
},
{
"kind": "Content",
"text": "(value: unknown) => boolean"
},
{
"kind": "Content",
"text": ", getEntries?: "
},
{
"kind": "Content",
"text": "(value: unknown) => [string, any][]"
},
{
"kind": "Content",
"text": ", ignoredPaths?: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "NonSerializableValue",
"canonicalReference": "@reduxjs/toolkit!~NonSerializableValue:interface"
},
{
"kind": "Content",
"text": " | false"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "path",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
}
},
{
"parameterName": "isSerializable",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
},
{
"parameterName": "getEntries",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
},
{
"parameterName": "ignoredPaths",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
}
}
],
"name": "findNonSerializableValue"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!getDefaultMiddleware:function(1)",
"docComment": "/**\n * Returns any array containing the default middleware installed by `configureStore()`. Useful if you want to configure your store with a custom `middleware` array but still keep the default set.\n *\n * @return The default middleware used by `configureStore()`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getDefaultMiddleware<S = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", O extends "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "GetDefaultMiddlewareOptions",
"canonicalReference": "@reduxjs/toolkit!~GetDefaultMiddlewareOptions:interface"
},
{
"kind": "Content",
"text": "> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "{\n thunk: true;\n immutableCheck: true;\n serializableCheck: true;\n}"
},
{
"kind": "Content",
"text": ">(options?: "
},
{
"kind": "Content",
"text": "O"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Array",
"canonicalReference": "!Array:interface"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Middleware",
"canonicalReference": "redux!Middleware:interface"
},
{
"kind": "Content",
"text": "<{}, S> | "
},
{
"kind": "Reference",
"text": "ThunkMiddlewareFor",
"canonicalReference": "@reduxjs/toolkit!ThunkMiddlewareFor:type"
},
{
"kind": "Content",
"text": "<S, O>>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 12,
"endIndex": 18
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
}
}
],
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "O",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 7
},
"defaultTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "getDefaultMiddleware"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!getType:function(1)",
"docComment": "/**\n * Returns the action type of the actions created by the passed `createAction()`-generated action creator (arbitrary action creators are not supported).\n *\n * @param - action The action creator whose action type to get.\n *\n * @returns The action type used by the action creator.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function getType<T extends "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ">(actionCreator: "
},
{
"kind": "Reference",
"text": "PayloadActionCreator",
"canonicalReference": "@reduxjs/toolkit!PayloadActionCreator:type"
},
{
"kind": "Content",
"text": "<any, T>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "actionCreator",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "getType"
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!IdSelector:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type IdSelector<T> = "
},
{
"kind": "Content",
"text": "(model: T) => "
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "IdSelector",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!ImmutableStateInvariantMiddlewareOptions:interface",
"docComment": "/**\n * Options for `createImmutableStateInvariantMiddleware()`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface ImmutableStateInvariantMiddlewareOptions "
}
],
"releaseTag": "Public",
"name": "ImmutableStateInvariantMiddlewareOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ImmutableStateInvariantMiddlewareOptions#ignore:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "ignore?: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ignore",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ImmutableStateInvariantMiddlewareOptions#ignoredPaths:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "ignoredPaths?: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ignoredPaths",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ImmutableStateInvariantMiddlewareOptions#isImmutable:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "isImmutable?: "
},
{
"kind": "Reference",
"text": "IsImmutableFunc",
"canonicalReference": "@reduxjs/toolkit!~IsImmutableFunc:type"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isImmutable",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!ImmutableStateInvariantMiddlewareOptions#warnAfter:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "warnAfter?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "warnAfter",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!isImmutableDefault:function(1)",
"docComment": "/**\n * The default `isImmutable` function.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function isImmutableDefault(value: "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "value",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "isImmutableDefault"
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!isPlain:function(1)",
"docComment": "/**\n * 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`.\n *\n * @param - val The value to check.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function isPlain(val: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "val",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "isPlain"
},
{
"kind": "Variable",
"canonicalReference": "@reduxjs/toolkit!nanoid:var",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "nanoid: "
},
{
"kind": "Content",
"text": "(size?: number) => string"
}
],
"releaseTag": "Public",
"name": "nanoid",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type",
"docComment": "/**\n * An action with a string type and an associated payload. This is the type of action returned by `createAction()` action creators.\n *\n * @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)\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type PayloadAction<P = "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ", T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", M = "
},
{
"kind": "Content",
"text": "never"
},
{
"kind": "Content",
"text": ", E = "
},
{
"kind": "Content",
"text": "never"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "{\n payload: P;\n type: T;\n} & ([M] extends [never] ? {} : {\n meta: M;\n}) & ([E] extends [never] ? {} : {\n error: E;\n})"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "PayloadAction",
"typeParameters": [
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"typeParameterName": "M",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
},
{
"typeParameterName": "E",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"typeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!PayloadActionCreator:type",
"docComment": "/**\n * An action creator that produces actions with a `payload` attribute.\n *\n * @typeParam - P the `payload` type\n *\n * @typeParam - T the `type` of the resulting action\n *\n * @typeParam - PA if the resulting action is preprocessed by a `prepare` method, the signature of said method.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type PayloadActionCreator<P = "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ", T extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", PA extends "
},
{
"kind": "Reference",
"text": "PrepareAction",
"canonicalReference": "@reduxjs/toolkit!PrepareAction:type"
},
{
"kind": "Content",
"text": "<P> | void "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Reference",
"text": "IfPrepareActionMethodProvided",
"canonicalReference": "@reduxjs/toolkit!~IfPrepareActionMethodProvided:type"
},
{
"kind": "Content",
"text": "<PA, "
},
{
"kind": "Reference",
"text": "_ActionCreatorWithPreparedPayload",
"canonicalReference": "@reduxjs/toolkit!_ActionCreatorWithPreparedPayload:type"
},
{
"kind": "Content",
"text": "<PA, T>, "
},
{
"kind": "Reference",
"text": "IsAny",
"canonicalReference": "@reduxjs/toolkit!IsAny:type"
},
{
"kind": "Content",
"text": "<P, "
},
{
"kind": "Reference",
"text": "ActionCreatorWithPayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPayload:interface"
},
{
"kind": "Content",
"text": "<any, T>, "
},
{
"kind": "Reference",
"text": "IsUnknownOrNonInferrable",
"canonicalReference": "@reduxjs/toolkit!IsUnknownOrNonInferrable:type"
},
{
"kind": "Content",
"text": "<P, "
},
{
"kind": "Reference",
"text": "ActionCreatorWithNonInferrablePayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithNonInferrablePayload:interface"
},
{
"kind": "Content",
"text": "<T>, "
},
{
"kind": "Reference",
"text": "IfVoid",
"canonicalReference": "@reduxjs/toolkit!IfVoid:type"
},
{
"kind": "Content",
"text": "<P, "
},
{
"kind": "Reference",
"text": "ActionCreatorWithoutPayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithoutPayload:interface"
},
{
"kind": "Content",
"text": "<T>, "
},
{
"kind": "Reference",
"text": "IfMaybeUndefined",
"canonicalReference": "@reduxjs/toolkit!IfMaybeUndefined:type"
},
{
"kind": "Content",
"text": "<P, "
},
{
"kind": "Reference",
"text": "ActionCreatorWithOptionalPayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithOptionalPayload:interface"
},
{
"kind": "Content",
"text": "<P, T>, "
},
{
"kind": "Reference",
"text": "ActionCreatorWithPayload",
"canonicalReference": "@reduxjs/toolkit!ActionCreatorWithPayload:interface"
},
{
"kind": "Content",
"text": "<P, T>>>>>>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "PayloadActionCreator",
"typeParameters": [
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"typeParameterName": "PA",
"constraintTokenRange": {
"startIndex": 7,
"endIndex": 9
},
"defaultTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
}
}
],
"typeTokenRange": {
"startIndex": 12,
"endIndex": 34
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!PrepareAction:type",
"docComment": "/**\n * 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).\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type PrepareAction<P> = "
},
{
"kind": "Content",
"text": "((...args: any[]) => {\n payload: P;\n}) | ((...args: any[]) => {\n payload: P;\n meta: any;\n}) | ((...args: any[]) => {\n payload: P;\n error: any;\n}) | ((...args: any[]) => {\n payload: P;\n meta: any;\n error: any;\n})"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "PrepareAction",
"typeParameters": [
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions:interface",
"docComment": "/**\n * Options for `createSerializableStateInvariantMiddleware()`.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface SerializableStateInvariantMiddlewareOptions "
}
],
"releaseTag": "Public",
"name": "SerializableStateInvariantMiddlewareOptions",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions#getEntries:member",
"docComment": "/**\n * The function that will be used to retrieve entries from each value. If unspecified, `Object.entries` will be used. Defaults to `undefined`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "getEntries?: "
},
{
"kind": "Content",
"text": "(value: any) => [string, any][]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "getEntries",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions#ignoredActionPaths:member",
"docComment": "/**\n * An array of dot-separated path strings to ignore when checking for serializability, Defaults to ['meta.arg']\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "ignoredActionPaths?: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ignoredActionPaths",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions#ignoredActions:member",
"docComment": "/**\n * An array of action types to ignore when checking for serializability, Defaults to []\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "ignoredActions?: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ignoredActions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions#ignoredPaths:member",
"docComment": "/**\n * An array of dot-separated path strings to ignore when checking for serializability, Defaults to []\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "ignoredPaths?: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ignoredPaths",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions#isSerializable:member",
"docComment": "/**\n * 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()`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "isSerializable?: "
},
{
"kind": "Content",
"text": "(value: any) => boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isSerializable",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializableStateInvariantMiddlewareOptions#warnAfter:member",
"docComment": "/**\n * Execution time warning threshold. If the middleware takes longer than `warnAfter` ms, a warning will be displayed in the console. Defaults to 32\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "warnAfter?: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "warnAfter",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!SerializedError:interface",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface SerializedError "
}
],
"releaseTag": "Public",
"name": "SerializedError",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializedError#code:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "code?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "code",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializedError#message:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "message?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "message",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializedError#name:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "name?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!SerializedError#stack:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "stack?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "stack",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "@reduxjs/toolkit!Slice:interface",
"docComment": "/**\n * The return value of `createSlice`\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Slice<State = "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ", CaseReducers extends "
},
{
"kind": "Reference",
"text": "SliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<State> "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Reference",
"text": "SliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<State>"
},
{
"kind": "Content",
"text": ", Name extends "
},
{
"kind": "Content",
"text": "string "
},
{
"kind": "Content",
"text": "= "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"typeParameterName": "CaseReducers",
"constraintTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
}
},
{
"typeParameterName": "Name",
"constraintTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"defaultTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
}
],
"name": "Slice",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!Slice#actions:member",
"docComment": "/**\n * Action creators for the types of actions that are handled by the slice reducer.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "actions: "
},
{
"kind": "Reference",
"text": "CaseReducerActions",
"canonicalReference": "@reduxjs/toolkit!CaseReducerActions:type"
},
{
"kind": "Content",
"text": "<CaseReducers>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "actions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!Slice#caseReducers:member",
"docComment": "/**\n * The individual case reducer functions that were passed in the `reducers` parameter. This enables reuse and testing if they were defined inline when calling `createSlice`.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "caseReducers: "
},
{
"kind": "Reference",
"text": "SliceDefinedCaseReducers",
"canonicalReference": "@reduxjs/toolkit!~SliceDefinedCaseReducers:type"
},
{
"kind": "Content",
"text": "<CaseReducers>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "caseReducers",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!Slice#name:member",
"docComment": "/**\n * The slice name.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "name: "
},
{
"kind": "Content",
"text": "Name"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@reduxjs/toolkit!Slice#reducer:member",
"docComment": "/**\n * The slice's reducer.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "reducer: "
},
{
"kind": "Reference",
"text": "Reducer",
"canonicalReference": "redux!Reducer:type"
},
{
"kind": "Content",
"text": "<State>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "reducer",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!SliceActionCreator:type",
"docComment": "/**\n * An action creator attached to a slice.\n *\n * @deprecated\n *\n * please use PayloadActionCreator directly\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type SliceActionCreator<P> = "
},
{
"kind": "Reference",
"text": "PayloadActionCreator",
"canonicalReference": "@reduxjs/toolkit!PayloadActionCreator:type"
},
{
"kind": "Content",
"text": "<P>"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "SliceActionCreator",
"typeParameters": [
{
"typeParameterName": "P",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type",
"docComment": "/**\n * The type describing a slice's `reducers` option.\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type SliceCaseReducers<State> = "
},
{
"kind": "Content",
"text": "{\n [K: string]: "
},
{
"kind": "Reference",
"text": "CaseReducer",
"canonicalReference": "@reduxjs/toolkit!CaseReducer:type"
},
{
"kind": "Content",
"text": "<State, "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<any>> | "
},
{
"kind": "Reference",
"text": "CaseReducerWithPrepare",
"canonicalReference": "@reduxjs/toolkit!CaseReducerWithPrepare:type"
},
{
"kind": "Content",
"text": "<State, "
},
{
"kind": "Reference",
"text": "PayloadAction",
"canonicalReference": "@reduxjs/toolkit!PayloadAction:type"
},
{
"kind": "Content",
"text": "<any, string, any, any>>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "SliceCaseReducers",
"typeParameters": [
{
"typeParameterName": "State",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 10
}
},
{
"kind": "Function",
"canonicalReference": "@reduxjs/toolkit!unwrapResult:function(1)",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function unwrapResult<R extends "
},
{
"kind": "Reference",
"text": "ActionTypesWithOptionalErrorAction",
"canonicalReference": "@reduxjs/toolkit!~ActionTypesWithOptionalErrorAction:type"
},
{
"kind": "Content",
"text": ">(returned: "
},
{
"kind": "Content",
"text": "R"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "PayloadForActionTypesExcludingErrorActions",
"canonicalReference": "@reduxjs/toolkit!~PayloadForActionTypesExcludingErrorActions:type"
},
{
"kind": "Content",
"text": "<R>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "returned",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"typeParameters": [
{
"typeParameterName": "R",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "unwrapResult"
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!Update:type",
"docComment": "/**\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type Update<T> = "
},
{
"kind": "Content",
"text": "{\n id: "
},
{
"kind": "Reference",
"text": "EntityId",
"canonicalReference": "@reduxjs/toolkit!EntityId:type"
},
{
"kind": "Content",
"text": ";\n changes: "
},
{
"kind": "Reference",
"text": "Partial",
"canonicalReference": "!Partial:type"
},
{
"kind": "Content",
"text": "<T>;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "Update",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "TypeAlias",
"canonicalReference": "@reduxjs/toolkit!ValidateSliceCaseReducers:type",
"docComment": "/**\n * Used on a SliceCaseReducers object. Ensures that if a CaseReducer is a `CaseReducerWithPrepare`, that the `reducer` and the `prepare` function use the same type of `payload`.\n *\n * Might do additional such checks in the future.\n *\n * This type is only ever useful if you want to write your own wrapper around `createSlice`. Please don't use it otherwise!\n *\n * @public\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type ValidateSliceCaseReducers<S, ACR extends "
},
{
"kind": "Reference",
"text": "SliceCaseReducers",
"canonicalReference": "@reduxjs/toolkit!SliceCaseReducers:type"
},
{
"kind": "Content",
"text": "<S>"
},
{
"kind": "Content",
"text": "> = "
},
{
"kind": "Content",
"text": "ACR & {\n [T in keyof ACR]: ACR[T] extends {\n reducer(s: S, action?: infer A): any;\n } ? {\n prepare(...a: never[]): "
},
{
"kind": "Reference",
"text": "Omit",
"canonicalReference": "@reduxjs/toolkit!Omit:type"
},
{
"kind": "Content",
"text": "<A, 'type'>;\n } : {};\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ValidateSliceCaseReducers",
"typeParameters": [
{
"typeParameterName": "S",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "ACR",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"typeTokenRange": {
"startIndex": 4,
"endIndex": 7
}
}
]
}
]
}
Raw
toolkit.asyncthunkaction.md

Home > @reduxjs/toolkit > AsyncThunkAction

AsyncThunkAction type

A ThunkAction created by createAsyncThunk. Dispatching it returns a Promise for either a fulfilled or rejected action. Also, the returned value contains a abort() method that allows the asyncAction to be cancelled from the outside.

Signature:

export declare type AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig extends AsyncThunkConfig> = (dispatch: GetDispatch<ThunkApiConfig>, getState: () => GetState<ThunkApiConfig>, extra: GetExtra<ThunkApiConfig>) => Promise<PayloadAction<Returned, string, {
    arg: ThunkArg;
    requestId: string;
}> | PayloadAction<undefined | GetRejectValue<ThunkApiConfig>, string, {
    arg: ThunkArg;
    requestId: string;
    aborted: boolean;
    condition: boolean;
}, SerializedError>> & {
    abort(reason?: string): void;
};
Raw
toolkit.asyncthunkpayloadcreator.md

Home > @reduxjs/toolkit > AsyncThunkPayloadCreator

AsyncThunkPayloadCreator type

A type describing the payloadCreator argument to createAsyncThunk. Might be useful for wrapping createAsyncThunk in custom abstractions.

Signature:

export declare type AsyncThunkPayloadCreator<Returned, ThunkArg = void, ThunkApiConfig extends AsyncThunkConfig = {}> = (arg: ThunkArg, thunkAPI: GetThunkAPI<ThunkApiConfig>) => AsyncThunkPayloadCreatorReturnValue<Returned, ThunkApiConfig>;
Raw
toolkit.asyncthunkpayloadcreatorreturnvalue.md

Home > @reduxjs/toolkit > AsyncThunkPayloadCreatorReturnValue

AsyncThunkPayloadCreatorReturnValue type

A type describing the return value of the payloadCreator argument to createAsyncThunk. Might be useful for wrapping createAsyncThunk in custom abstractions.

Signature:

export declare type AsyncThunkPayloadCreatorReturnValue<Returned, ThunkApiConfig extends AsyncThunkConfig> = Promise<Returned | RejectWithValue<GetRejectValue<ThunkApiConfig>>> | Returned | RejectWithValue<GetRejectValue<ThunkApiConfig>>;
Raw
toolkit.casereducer.md

Home > @reduxjs/toolkit > CaseReducer

CaseReducer type

An *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.

Signature:

export declare type CaseReducer<S = any, A extends Action = AnyAction> = (state: Draft<S>, action: A) => S | void;
Raw
toolkit.casereduceractions.md

Home > @reduxjs/toolkit > CaseReducerActions

CaseReducerActions type

Derives the slice's actions property from the reducers options

Signature:

export declare type CaseReducerActions<CaseReducers extends SliceCaseReducers<any>> = {
    [Type in keyof CaseReducers]: CaseReducers[Type] extends {
        prepare: any;
    } ? ActionCreatorForCaseReducerWithPrepare<CaseReducers[Type]> : ActionCreatorForCaseReducer<CaseReducers[Type]>;
};
Raw
toolkit.casereducers.md

Home > @reduxjs/toolkit > CaseReducers

CaseReducers type

Warning: This API is now obsolete.

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.

A mapping from action types to case reducers for createReducer().

Signature:

export declare type CaseReducers<S, AS extends Actions> = {
    [T in keyof AS]: AS[T] extends Action ? CaseReducer<S, AS[T]> : void;
};
Raw
toolkit.casereducerwithprepare.md

Home > @reduxjs/toolkit > CaseReducerWithPrepare

CaseReducerWithPrepare type

A CaseReducer with a prepare method.

Signature:

export declare type CaseReducerWithPrepare<State, Action extends PayloadAction> = {
    reducer: CaseReducer<State, Action>;
    prepare: PrepareAction<Action['payload']>;
};
Raw
toolkit.comparer.md
Raw
toolkit.configureenhancerscallback.md

Home > @reduxjs/toolkit > ConfigureEnhancersCallback

ConfigureEnhancersCallback type

Callback function type, to be used in ConfigureStoreOptions.enhancers

Signature:

export declare type ConfigureEnhancersCallback = (defaultEnhancers: StoreEnhancer[]) => StoreEnhancer[];
Raw
toolkit.configurestore.md

Home > @reduxjs/toolkit > configureStore

configureStore() function

A friendly abstraction over the standard Redux createStore() function.

Signature:

export declare function configureStore<S = any, A extends Action = AnyAction, M extends Middlewares<S> = [ThunkMiddlewareFor<S>]>(options: ConfigureStoreOptions<S, A, M>): EnhancedStore<S, A, M>;

Parameters

Parameter Type Description
options ConfigureStoreOptions<S, A, M>

Returns:

EnhancedStore<S, A, M>

A configured Redux store.

Raw
toolkit.configurestoreoptions.devtools.md

Home > @reduxjs/toolkit > ConfigureStoreOptions > devTools

ConfigureStoreOptions.devTools property

Whether to enable Redux DevTools integration. Defaults to true.

Additional configuration can be done by passing Redux DevTools options

Signature:

devTools?: boolean | DevToolsOptions;
Raw
toolkit.configurestoreoptions.enhancers.md

Home > @reduxjs/toolkit > ConfigureStoreOptions > enhancers

ConfigureStoreOptions.enhancers property

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 the original array (ie, [applyMiddleware]), and should return a new array (such as [applyMiddleware, offline]). If you only need to add middleware, you can use the middleware parameter instaead.

Signature:

enhancers?: StoreEnhancer[] | ConfigureEnhancersCallback;
Raw
toolkit.configurestoreoptions.md

Home > @reduxjs/toolkit > ConfigureStoreOptions

ConfigureStoreOptions interface

Options for configureStore().

Signature:

export interface ConfigureStoreOptions<S = any, A extends Action = AnyAction, M extends Middlewares<S> = Middlewares<S>>

Properties

Property Type Description
devTools boolean | DevToolsOptions Whether to enable Redux DevTools integration. Defaults to true.Additional configuration can be done by passing Redux DevTools options
enhancers StoreEnhancer[] | ConfigureEnhancersCallback 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 the original array (ie, [applyMiddleware]), and should return a new array (such as [applyMiddleware, offline]). If you only need to add middleware, you can use the middleware parameter instaead.
middleware M An array of Redux middleware to install. If not supplied, defaults to the set of middleware returned by getDefaultMiddleware().
preloadedState DeepPartial<S extends any ? S : S> 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.
reducer Reducer<S, A> | ReducersMapObject<S, A> A single reducer function that will be used as the root reducer, or an object of slice reducers that will be passed to combineReducers().
Raw
toolkit.configurestoreoptions.middleware.md

Home > @reduxjs/toolkit > ConfigureStoreOptions > middleware

ConfigureStoreOptions.middleware property

An array of Redux middleware to install. If not supplied, defaults to the set of middleware returned by getDefaultMiddleware().

Signature:

middleware?: M;
Raw
toolkit.configurestoreoptions.preloadedstate.md

Home > @reduxjs/toolkit > ConfigureStoreOptions > preloadedState

ConfigureStoreOptions.preloadedState property

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.

Signature:

preloadedState?: DeepPartial<S extends any ? S : S>;
Raw
toolkit.configurestoreoptions.reducer.md

Home > @reduxjs/toolkit > ConfigureStoreOptions > reducer

ConfigureStoreOptions.reducer property

A single reducer function that will be used as the root reducer, or an object of slice reducers that will be passed to combineReducers().

Signature:

reducer: Reducer<S, A> | ReducersMapObject<S, A>;
Raw
toolkit.createaction.md

Home > @reduxjs/toolkit > createAction

createAction() function

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() overriden so that it returns the action type, allowing it to be used in reducer logic that is looking for that action type.

Signature:

export declare function createAction<P = void, T extends string = string>(type: T): PayloadActionCreator<P, T>;

Parameters

Parameter Type Description
type T

Returns:

PayloadActionCreator<P, T>

Raw
toolkit.createaction_1.md

Home > @reduxjs/toolkit > createAction

createAction() function

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() overriden so that it returns the action type, allowing it to be used in reducer logic that is looking for that action type.

Signature:

export declare function createAction<PA extends PrepareAction<any>, T extends string = string>(type: T, prepareAction: PA): PayloadActionCreator<ReturnType<PA>['payload'], T, PA>;

Parameters

Parameter Type Description
type T
prepareAction PA

Returns:

PayloadActionCreator<ReturnType<PA>['payload'], T, PA>

Raw
toolkit.createasyncthunk.md

Home > @reduxjs/toolkit > createAsyncThunk

createAsyncThunk() function

Signature:

export declare function createAsyncThunk<Returned, ThunkArg = void, ThunkApiConfig extends AsyncThunkConfig = {}>(type: string, payloadCreator: (arg: ThunkArg, thunkAPI: GetThunkAPI<ThunkApiConfig>) => Promise<Returned | RejectWithValue<GetRejectValue<ThunkApiConfig>>> | Returned | RejectWithValue<GetRejectValue<ThunkApiConfig>>, options?: AsyncThunkOptions<ThunkArg, ThunkApiConfig>): IsAny<ThunkArg, (arg: ThunkArg) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig>, unknown extends ThunkArg ? (arg: ThunkArg) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : [ThunkArg] extends [void] | [undefined] ? () => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : [void] extends [ThunkArg] ? (arg?: ThunkArg | undefined) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : [undefined] extends [ThunkArg] ? (arg?: ThunkArg | undefined) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : (arg: ThunkArg) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig>> & {
    pending: ActionCreatorWithPreparedPayload<[string, ThunkArg], undefined, string, never, {
        arg: ThunkArg;
        requestId: string;
    }>;
    rejected: ActionCreatorWithPreparedPayload<[Error | null, string, ThunkArg, (GetRejectValue<ThunkApiConfig> | undefined)?], GetRejectValue<ThunkApiConfig> | undefined, string, SerializedError, {
        arg: ThunkArg;
        requestId: string;
        aborted: boolean;
        condition: boolean;
    }>;
    fulfilled: ActionCreatorWithPreparedPayload<[Returned, string, ThunkArg], Returned, string, never, {
        arg: ThunkArg;
        requestId: string;
    }>;
};

Parameters

Parameter Type Description
type string
payloadCreator (arg: ThunkArg, thunkAPI: GetThunkAPI<ThunkApiConfig>) => Promise<Returned | RejectWithValue<GetRejectValue<ThunkApiConfig>>> | Returned | RejectWithValue<GetRejectValue<ThunkApiConfig>>
options AsyncThunkOptions<ThunkArg, ThunkApiConfig>

Returns:

IsAny<ThunkArg, (arg: ThunkArg) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig>, unknown extends ThunkArg ? (arg: ThunkArg) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : [ThunkArg] extends [void] | [undefined] ? () => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : [void] extends [ThunkArg] ? (arg?: ThunkArg | undefined) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : [undefined] extends [ThunkArg] ? (arg?: ThunkArg | undefined) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig> : (arg: ThunkArg) => AsyncThunkAction<Returned, ThunkArg, ThunkApiConfig>> & { pending: ActionCreatorWithPreparedPayload<[string, ThunkArg], undefined, string, never, { arg: ThunkArg; requestId: string; }>; rejected: ActionCreatorWithPreparedPayload<[Error | null, string, ThunkArg, (GetRejectValue<ThunkApiConfig> | undefined)?], GetRejectValue<ThunkApiConfig> | undefined, string, SerializedError, { arg: ThunkArg; requestId: string; aborted: boolean; condition: boolean; }>; fulfilled: ActionCreatorWithPreparedPayload<[Returned, string, ThunkArg], Returned, string, never, { arg: ThunkArg; requestId: string; }>; }

Raw
toolkit.createentityadapter.md

Home > @reduxjs/toolkit > createEntityAdapter

createEntityAdapter() function

Signature:

export declare function createEntityAdapter<T>(options?: {
    selectId?: IdSelector<T>;
    sortComparer?: false | Comparer<T>;
}): EntityAdapter<T>;

Parameters

Parameter Type Description
options {
selectId?: IdSelector<T>;
sortComparer?: false | Comparer<T>;
}

Returns:

EntityAdapter<T>

Raw
toolkit.createimmutablestateinvariantmiddleware.md

Home > @reduxjs/toolkit > createImmutableStateInvariantMiddleware

createImmutableStateInvariantMiddleware() function

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.

Signature:

export declare function createImmutableStateInvariantMiddleware(options?: ImmutableStateInvariantMiddlewareOptions): Middleware;

Parameters

Parameter Type Description
options ImmutableStateInvariantMiddlewareOptions

Returns:

Middleware

Raw
toolkit.createreducer.md

Home > @reduxjs/toolkit > createReducer

createReducer() function

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.

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.

Signature:

export declare function createReducer<S, CR extends CaseReducers<S, any> = CaseReducers<S, any>>(initialState: S, actionsMap: CR): Reducer<S>;

Parameters

Parameter Type Description
initialState S
actionsMap CR

Returns:

Reducer<S>

Raw
toolkit.createreducer_1.md

Home > @reduxjs/toolkit > createReducer

createReducer() function

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.

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.

Signature:

export declare function createReducer<S>(initialState: S, builderCallback: (builder: ActionReducerMapBuilder<S>) => void): Reducer<S>;

Parameters

Parameter Type Description
initialState S
builderCallback (builder: ActionReducerMapBuilder<S>) => void

Returns:

Reducer<S>

Raw
toolkit.createserializablestateinvariantmiddleware.md

Home > @reduxjs/toolkit > createSerializableStateInvariantMiddleware

createSerializableStateInvariantMiddleware() function

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.

Signature:

export declare function createSerializableStateInvariantMiddleware(options?: SerializableStateInvariantMiddlewareOptions): Middleware;

Parameters

Parameter Type Description
options SerializableStateInvariantMiddlewareOptions

Returns:

Middleware

Raw
toolkit.createslice.md

Home > @reduxjs/toolkit > createSlice

createSlice() function

A function that accepts an initial state, an object full of reducer functions, and a "slice name", and automatically generates action creators and action types that correspond to the reducers and state.

The reducer argument is passed to createReducer().

Signature:

export declare function createSlice<State, CaseReducers extends SliceCaseReducers<State>, Name extends string = string>(options: CreateSliceOptions<State, CaseReducers, Name>): Slice<State, CaseReducers, Name>;

Parameters

Parameter Type Description
options CreateSliceOptions<State, CaseReducers, Name>

Returns:

Slice<State, CaseReducers, Name>

Raw
toolkit.createsliceoptions.extrareducers.md

Home > @reduxjs/toolkit > CreateSliceOptions > extraReducers

CreateSliceOptions.extraReducers property

A mapping from action types to action-type-specific *case reducer* functions. These reducers should have existing action types used as the keys, and action creators will _not_ be generated. Alternatively, a callback that receives a *builder* object to define case reducers via calls to builder.addCase(actionCreatorOrType, reducer).

Signature:

extraReducers?: CaseReducers<NoInfer<State>, any> | ((builder: ActionReducerMapBuilder<NoInfer<State>>) => void);
Raw
toolkit.createsliceoptions.initialstate.md
Raw
toolkit.createsliceoptions.md

Home > @reduxjs/toolkit > CreateSliceOptions

CreateSliceOptions interface

Options for createSlice().

Signature:

export interface CreateSliceOptions<State = any, CR extends SliceCaseReducers<State> = SliceCaseReducers<State>, Name extends string = string>

Properties

Property Type Description
extraReducers CaseReducers<NoInfer<State>, any> | ((builder: ActionReducerMapBuilder<NoInfer<State>>) => void) A mapping from action types to action-type-specific *case reducer* functions. These reducers should have existing action types used as the keys, and action creators will _not_ be generated. Alternatively, a callback that receives a *builder* object to define case reducers via calls to builder.addCase(actionCreatorOrType, reducer).
initialState State The initial state to be returned by the slice reducer.
name Name The slice's name. Used to namespace the generated action types.
reducers ValidateSliceCaseReducers<State, CR> A mapping from action types to action-type-specific *case reducer* functions. For every action type, a matching action creator will be generated using createAction().
Raw
toolkit.createsliceoptions.name.md
Raw
toolkit.createsliceoptions.reducers.md

Home > @reduxjs/toolkit > CreateSliceOptions > reducers

CreateSliceOptions.reducers property

A mapping from action types to action-type-specific *case reducer* functions. For every action type, a matching action creator will be generated using createAction().

Signature:

reducers: ValidateSliceCaseReducers<State, CR>;
Raw
toolkit.dictionary.md
Raw
toolkit.enhancedstore.dispatch.md

Home > @reduxjs/toolkit > EnhancedStore > dispatch

EnhancedStore.dispatch property

The dispatch method of your store, enhanced by all it's middlewares.

Signature:

dispatch: DispatchForMiddlewares<M> & Dispatch<A>;
Raw
toolkit.enhancedstore.md

Home > @reduxjs/toolkit > EnhancedStore

EnhancedStore interface

A Redux store returned by configureStore(). Supports dispatching side-effectful _thunks_ in addition to plain actions.

Signature:

export interface EnhancedStore<S = any, A extends Action = AnyAction, M extends Middlewares<S> = Middlewares<S>> extends Store<S, A>

Properties

Property Type Description
dispatch DispatchForMiddlewares<M> & Dispatch<A> The dispatch method of your store, enhanced by all it's middlewares.
Raw
toolkit.entityadapter.getinitialstate.md
Raw
toolkit.entityadapter.getinitialstate_1.md

Home > @reduxjs/toolkit > EntityAdapter > getInitialState

EntityAdapter.getInitialState() method

Signature:

getInitialState<S extends object>(state: S): EntityState<T> & S;

Parameters

Parameter Type Description
state S

Returns:

EntityState<T> & S

Raw
toolkit.entityadapter.getselectors.md
Raw
toolkit.entityadapter.getselectors_1.md

Home > @reduxjs/toolkit > EntityAdapter > getSelectors

EntityAdapter.getSelectors() method

Signature:

getSelectors<V>(selectState: (state: V) => EntityState<T>): EntitySelectors<T, V>;

Parameters

Parameter Type Description
selectState (state: V) => EntityState<T>

Returns:

EntitySelectors<T, V>

Raw
toolkit.entityadapter.md
Raw
toolkit.entityadapter.selectid.md
Raw
toolkit.entityadapter.sortcomparer.md
Raw
toolkit.entityid.md
Raw
toolkit.entityselectors.md
Raw
toolkit.entityselectors.selectall.md
Raw
toolkit.entityselectors.selectbyid.md
Raw
toolkit.entityselectors.selectentities.md
Raw
toolkit.entityselectors.selectids.md
Raw
toolkit.entityselectors.selecttotal.md
Raw
toolkit.entitystate.entities.md
Raw
toolkit.entitystate.ids.md
Raw
toolkit.entitystate.md
Raw
toolkit.entitystateadapter.addmany.md

Home > @reduxjs/toolkit > EntityStateAdapter > addMany

EntityStateAdapter.addMany() method

Signature:

addMany<S extends EntityState<T>>(state: PreventAny<S, T>, entities: T[] | Record<EntityId, T>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entities T[] | Record<EntityId, T>

Returns:

S

Raw
toolkit.entitystateadapter.addmany_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > addMany

EntityStateAdapter.addMany() method

Signature:

addMany<S extends EntityState<T>>(state: PreventAny<S, T>, entities: PayloadAction<T[] | Record<EntityId, T>>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entities PayloadAction<T[] | Record<EntityId, T>>

Returns:

S

Raw
toolkit.entitystateadapter.addone.md

Home > @reduxjs/toolkit > EntityStateAdapter > addOne

EntityStateAdapter.addOne() method

Signature:

addOne<S extends EntityState<T>>(state: PreventAny<S, T>, entity: T): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entity T

Returns:

S

Raw
toolkit.entitystateadapter.addone_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > addOne

EntityStateAdapter.addOne() method

Signature:

addOne<S extends EntityState<T>>(state: PreventAny<S, T>, action: PayloadAction<T>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
action PayloadAction<T>

Returns:

S

Raw
toolkit.entitystateadapter.removeall.md

Home > @reduxjs/toolkit > EntityStateAdapter > removeAll

EntityStateAdapter.removeAll() method

Signature:

removeAll<S extends EntityState<T>>(state: PreventAny<S, T>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>

Returns:

S

Raw
toolkit.entitystateadapter.removemany.md

Home > @reduxjs/toolkit > EntityStateAdapter > removeMany

EntityStateAdapter.removeMany() method

Signature:

removeMany<S extends EntityState<T>>(state: PreventAny<S, T>, keys: EntityId[]): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
keys EntityId[]

Returns:

S

Raw
toolkit.entitystateadapter.removemany_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > removeMany

EntityStateAdapter.removeMany() method

Signature:

removeMany<S extends EntityState<T>>(state: PreventAny<S, T>, keys: PayloadAction<EntityId[]>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
keys PayloadAction<EntityId[]>

Returns:

S

Raw
toolkit.entitystateadapter.removeone.md

Home > @reduxjs/toolkit > EntityStateAdapter > removeOne

EntityStateAdapter.removeOne() method

Signature:

removeOne<S extends EntityState<T>>(state: PreventAny<S, T>, key: EntityId): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
key EntityId

Returns:

S

Raw
toolkit.entitystateadapter.removeone_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > removeOne

EntityStateAdapter.removeOne() method

Signature:

removeOne<S extends EntityState<T>>(state: PreventAny<S, T>, key: PayloadAction<EntityId>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
key PayloadAction<EntityId>

Returns:

S

Raw
toolkit.entitystateadapter.setall.md

Home > @reduxjs/toolkit > EntityStateAdapter > setAll

EntityStateAdapter.setAll() method

Signature:

setAll<S extends EntityState<T>>(state: PreventAny<S, T>, entities: T[] | Record<EntityId, T>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entities T[] | Record<EntityId, T>

Returns:

S

Raw
toolkit.entitystateadapter.setall_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > setAll

EntityStateAdapter.setAll() method

Signature:

setAll<S extends EntityState<T>>(state: PreventAny<S, T>, entities: PayloadAction<T[] | Record<EntityId, T>>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entities PayloadAction<T[] | Record<EntityId, T>>

Returns:

S

Raw
toolkit.entitystateadapter.updatemany.md

Home > @reduxjs/toolkit > EntityStateAdapter > updateMany

EntityStateAdapter.updateMany() method

Signature:

updateMany<S extends EntityState<T>>(state: PreventAny<S, T>, updates: Update<T>[]): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
updates Update<T>[]

Returns:

S

Raw
toolkit.entitystateadapter.updatemany_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > updateMany

EntityStateAdapter.updateMany() method

Signature:

updateMany<S extends EntityState<T>>(state: PreventAny<S, T>, updates: PayloadAction<Update<T>[]>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
updates PayloadAction<Update<T>[]>

Returns:

S

Raw
toolkit.entitystateadapter.updateone.md

Home > @reduxjs/toolkit > EntityStateAdapter > updateOne

EntityStateAdapter.updateOne() method

Signature:

updateOne<S extends EntityState<T>>(state: PreventAny<S, T>, update: Update<T>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
update Update<T>

Returns:

S

Raw
toolkit.entitystateadapter.updateone_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > updateOne

EntityStateAdapter.updateOne() method

Signature:

updateOne<S extends EntityState<T>>(state: PreventAny<S, T>, update: PayloadAction<Update<T>>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
update PayloadAction<Update<T>>

Returns:

S

Raw
toolkit.entitystateadapter.upsertmany.md

Home > @reduxjs/toolkit > EntityStateAdapter > upsertMany

EntityStateAdapter.upsertMany() method

Signature:

upsertMany<S extends EntityState<T>>(state: PreventAny<S, T>, entities: T[] | Record<EntityId, T>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entities T[] | Record<EntityId, T>

Returns:

S

Raw
toolkit.entitystateadapter.upsertmany_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > upsertMany

EntityStateAdapter.upsertMany() method

Signature:

upsertMany<S extends EntityState<T>>(state: PreventAny<S, T>, entities: PayloadAction<T[] | Record<EntityId, T>>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entities PayloadAction<T[] | Record<EntityId, T>>

Returns:

S

Raw
toolkit.entitystateadapter.upsertone.md

Home > @reduxjs/toolkit > EntityStateAdapter > upsertOne

EntityStateAdapter.upsertOne() method

Signature:

upsertOne<S extends EntityState<T>>(state: PreventAny<S, T>, entity: T): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entity T

Returns:

S

Raw
toolkit.entitystateadapter.upsertone_1.md

Home > @reduxjs/toolkit > EntityStateAdapter > upsertOne

EntityStateAdapter.upsertOne() method

Signature:

upsertOne<S extends EntityState<T>>(state: PreventAny<S, T>, entity: PayloadAction<T>): S;

Parameters

Parameter Type Description
state PreventAny<S, T>
entity PayloadAction<T>

Returns:

S

Raw
toolkit.findnonserializablevalue.md

Home > @reduxjs/toolkit > findNonSerializableValue

findNonSerializableValue() function

Signature:

export declare function findNonSerializableValue(value: unknown, path?: ReadonlyArray<string>, isSerializable?: (value: unknown) => boolean, getEntries?: (value: unknown) => [string, any][], ignoredPaths?: string[]): NonSerializableValue | false;

Parameters

Parameter Type Description
value unknown
path ReadonlyArray<string>
isSerializable (value: unknown) => boolean
getEntries (value: unknown) => [string, any][]
ignoredPaths string[]

Returns:

NonSerializableValue | false

Raw
toolkit.getdefaultmiddleware.md

Home > @reduxjs/toolkit > getDefaultMiddleware

getDefaultMiddleware() function

Returns any array containing the default middleware installed by configureStore(). Useful if you want to configure your store with a custom middleware array but still keep the default set.

The default middleware used by configureStore().

Signature:

export declare function getDefaultMiddleware<S = any, O extends Partial<GetDefaultMiddlewareOptions> = {
    thunk: true;
    immutableCheck: true;
    serializableCheck: true;
}>(options?: O): Array<Middleware<{}, S> | ThunkMiddlewareFor<S, O>>;

Parameters

Parameter Type Description
options O

Returns:

Array<Middleware<{}, S> | ThunkMiddlewareFor<S, O>>

Raw
toolkit.gettype.md

Home > @reduxjs/toolkit > getType

getType() function

Returns the action type of the actions created by the passed createAction()-generated action creator (arbitrary action creators are not supported).

Signature:

export declare function getType<T extends string>(actionCreator: PayloadActionCreator<any, T>): T;

Parameters

Parameter Type Description
actionCreator PayloadActionCreator<any, T>

Returns:

T

The action type used by the action creator.

Raw
toolkit.idselector.md
Raw
toolkit.immutablestateinvariantmiddlewareoptions.ignore.md
Raw
toolkit.immutablestateinvariantmiddlewareoptions.ignoredpaths.md
Raw
toolkit.immutablestateinvariantmiddlewareoptions.isimmutable.md
Raw
toolkit.immutablestateinvariantmiddlewareoptions.md
Raw
toolkit.immutablestateinvariantmiddlewareoptions.warnafter.md
Raw
toolkit.isimmutabledefault.md

Home > @reduxjs/toolkit > isImmutableDefault

isImmutableDefault() function

The default isImmutable function.

Signature:

export declare function isImmutableDefault(value: unknown): boolean;

Parameters

Parameter Type Description
value unknown

Returns:

boolean

Raw
toolkit.isplain.md

Home > @reduxjs/toolkit > isPlain

isPlain() function

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.

Signature:

export declare function isPlain(val: any): boolean;

Parameters

Parameter Type Description
val any

Returns:

boolean

Raw
toolkit.md

Home > @reduxjs/toolkit

toolkit package

Functions

Function Description
configureStore(options) A friendly abstraction over the standard Redux createStore() function.
createAction(type) 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() overriden so that it returns the action type, allowing it to be used in reducer logic that is looking for that action type.
createAction(type, prepareAction) 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() overriden so that it returns the action type, allowing it to be used in reducer logic that is looking for that action type.
createAsyncThunk(type, payloadCreator, options)
createEntityAdapter(options)
createImmutableStateInvariantMiddleware(options) 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.
createReducer(initialState, actionsMap) 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.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.
createReducer(initialState, builderCallback) 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.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.
createSerializableStateInvariantMiddleware(options) 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.
createSlice(options) A function that accepts an initial state, an object full of reducer functions, and a "slice name", and automatically generates action creators and action types that correspond to the reducers and state.The reducer argument is passed to createReducer().
findNonSerializableValue(value, path, isSerializable, getEntries, ignoredPaths)
getDefaultMiddleware(options) Returns any array containing the default middleware installed by configureStore(). Useful if you want to configure your store with a custom middleware array but still keep the default set. The default middleware used by configureStore().
getType(actionCreator) Returns the action type of the actions created by the passed createAction()-generated action creator (arbitrary action creators are not supported).
isImmutableDefault(value) The default isImmutable function.
isPlain(val) 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.
unwrapResult(returned)

Interfaces

Interface Description
ActionCreatorWithNonInferrablePayload An action creator of type T whose payload type could not be inferred. Accepts everything as payload. {redux#ActionCreator}
ActionCreatorWithOptionalPayload An action creator of type T that takes an optional payload of type P. {redux#ActionCreator}
ActionCreatorWithoutPayload An action creator of type T that takes no payload. {redux#ActionCreator}
ActionCreatorWithPayload An action creator of type T that requires a payload of type P. {redux#ActionCreator}
ActionCreatorWithPreparedPayload An action creator that takes multiple arguments that are passed to a PrepareAction method to create the final Action.
ActionReducerMapBuilder A builder for an action <-> reducer map.
ConfigureStoreOptions Options for configureStore().
CreateSliceOptions Options for createSlice().
Dictionary
EnhancedStore A Redux store returned by configureStore(). Supports dispatching side-effectful _thunks_ in addition to plain actions.
EntityAdapter
EntitySelectors
EntityState
EntityStateAdapter
ImmutableStateInvariantMiddlewareOptions Options for createImmutableStateInvariantMiddleware().
SerializableStateInvariantMiddlewareOptions Options for createSerializableStateInvariantMiddleware().
SerializedError
Slice The return value of createSlice

Variables

Variable Description
nanoid

Type Aliases

Type Alias Description
Actions Defines a mapping from action types to corresponding action object shapes.
AsyncThunkAction A ThunkAction created by createAsyncThunk. Dispatching it returns a Promise for either a fulfilled or rejected action. Also, the returned value contains a abort() method that allows the asyncAction to be cancelled from the outside.
AsyncThunkPayloadCreator A type describing the payloadCreator argument to createAsyncThunk. Might be useful for wrapping createAsyncThunk in custom abstractions.
AsyncThunkPayloadCreatorReturnValue A type describing the return value of the payloadCreator argument to createAsyncThunk. Might be useful for wrapping createAsyncThunk in custom abstractions.
CaseReducer An *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.
CaseReducerActions Derives the slice's actions property from the reducers options
CaseReducers A mapping from action types to case reducers for createReducer().
CaseReducerWithPrepare A CaseReducer with a prepare method.
Comparer
ConfigureEnhancersCallback Callback function type, to be used in ConfigureStoreOptions.enhancers
EntityId
IdSelector
PayloadAction An action with a string type and an associated payload. This is the type of action returned by createAction() action creators. P The type of the action's payload. T the type used for the action type. M The type of the action's meta (optional) E The type of the action's error (optional)
PayloadActionCreator An action creator that produces actions with a payload attribute.
PrepareAction 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).
SliceActionCreator An action creator attached to a slice.
SliceCaseReducers The type describing a slice's reducers option.
Update
ValidateSliceCaseReducers Used on a SliceCaseReducers object. Ensures that if a CaseReducer is a CaseReducerWithPrepare, that the reducer and the prepare function use the same type of payload.Might do additional such checks in the future.This type is only ever useful if you want to write your own wrapper around createSlice. Please don't use it otherwise!
Raw
toolkit.nanoid.md
Raw
toolkit.payloadaction.md

Home > @reduxjs/toolkit > PayloadAction

PayloadAction type

An action with a string type and an associated payload. This is the type of action returned by createAction() action creators.

P The type of the action's payload. T the type used for the action type. M The type of the action's meta (optional) E The type of the action's error (optional)

Signature:

export declare type PayloadAction<P = void, T extends string = string, M = never, E = never> = {
    payload: P;
    type: T;
} & ([M] extends [never] ? {} : {
    meta: M;
}) & ([E] extends [never] ? {} : {
    error: E;
});
Raw
toolkit.payloadactioncreator.md

Home > @reduxjs/toolkit > PayloadActionCreator

PayloadActionCreator type

An action creator that produces actions with a payload attribute.

Signature:

export declare type PayloadActionCreator<P = void, T extends string = string, PA extends PrepareAction<P> | 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>>>>>>;
Raw
toolkit.prepareaction.md

Home > @reduxjs/toolkit > PrepareAction

PrepareAction type

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).

Signature:

export declare type PrepareAction<P> = ((...args: any[]) => {
    payload: P;
}) | ((...args: any[]) => {
    payload: P;
    meta: any;
}) | ((...args: any[]) => {
    payload: P;
    error: any;
}) | ((...args: any[]) => {
    payload: P;
    meta: any;
    error: any;
});
Raw
toolkit.serializablestateinvariantmiddlewareoptions.getentries.md
Raw
toolkit.serializablestateinvariantmiddlewareoptions.ignoredactionpaths.md
Raw
toolkit.serializablestateinvariantmiddlewareoptions.ignoredactions.md
Raw
toolkit.serializablestateinvariantmiddlewareoptions.ignoredpaths.md
Raw
toolkit.serializablestateinvariantmiddlewareoptions.isserializable.md
Raw
toolkit.serializablestateinvariantmiddlewareoptions.md

Home > @reduxjs/toolkit > SerializableStateInvariantMiddlewareOptions

SerializableStateInvariantMiddlewareOptions interface

Options for createSerializableStateInvariantMiddleware().

Signature:

export interface SerializableStateInvariantMiddlewareOptions

Properties

Property Type Description
getEntries (value: any) => [string, any][] The function that will be used to retrieve entries from each value. If unspecified, Object.entries will be used. Defaults to undefined.
ignoredActionPaths string[] An array of dot-separated path strings to ignore when checking for serializability, Defaults to ['meta.arg']
ignoredActions string[] An array of action types to ignore when checking for serializability, Defaults to []
ignoredPaths string[] An array of dot-separated path strings to ignore when checking for serializability, Defaults to []
isSerializable (value: any) => boolean 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().
warnAfter number Execution time warning threshold. If the middleware takes longer than warnAfter ms, a warning will be displayed in the console. Defaults to 32
Raw
toolkit.serializablestateinvariantmiddlewareoptions.warnafter.md
Raw
toolkit.serializederror.code.md
Raw
toolkit.serializederror.md
Raw
toolkit.serializederror.message.md
Raw
toolkit.serializederror.name.md
Raw
toolkit.serializederror.stack.md
Raw
toolkit.slice.actions.md

Home > @reduxjs/toolkit > Slice > actions

Slice.actions property

Action creators for the types of actions that are handled by the slice reducer.

Signature:

actions: CaseReducerActions<CaseReducers>;
Raw
toolkit.slice.casereducers.md

Home > @reduxjs/toolkit > Slice > caseReducers

Slice.caseReducers property

The individual case reducer functions that were passed in the reducers parameter. This enables reuse and testing if they were defined inline when calling createSlice.

Signature:

caseReducers: SliceDefinedCaseReducers<CaseReducers>;
Raw
toolkit.slice.md

Home > @reduxjs/toolkit > Slice

Slice interface

The return value of createSlice

Signature:

export interface Slice<State = any, CaseReducers extends SliceCaseReducers<State> = SliceCaseReducers<State>, Name extends string = string>

Properties

Property Type Description
actions CaseReducerActions<CaseReducers> Action creators for the types of actions that are handled by the slice reducer.
caseReducers SliceDefinedCaseReducers<CaseReducers> The individual case reducer functions that were passed in the reducers parameter. This enables reuse and testing if they were defined inline when calling createSlice.
name Name The slice name.
reducer Reducer<State> The slice's reducer.
Raw
toolkit.slice.name.md
Raw
toolkit.slice.reducer.md
Raw
toolkit.sliceactioncreator.md

Home > @reduxjs/toolkit > SliceActionCreator

SliceActionCreator type

Warning: This API is now obsolete.

please use PayloadActionCreator directly

An action creator attached to a slice.

Signature:

export declare type SliceActionCreator<P> = PayloadActionCreator<P>;
Raw
toolkit.slicecasereducers.md

Home > @reduxjs/toolkit > SliceCaseReducers

SliceCaseReducers type

The type describing a slice's reducers option.

Signature:

export declare type SliceCaseReducers<State> = {
    [K: string]: CaseReducer<State, PayloadAction<any>> | CaseReducerWithPrepare<State, PayloadAction<any, string, any, any>>;
};
Raw
toolkit.unwrapresult.md

Home > @reduxjs/toolkit > unwrapResult

unwrapResult() function

Signature:

export declare function unwrapResult<R extends ActionTypesWithOptionalErrorAction>(returned: R): PayloadForActionTypesExcludingErrorActions<R>;

Parameters

Parameter Type Description
returned R

Returns:

PayloadForActionTypesExcludingErrorActions<R>

Raw
toolkit.update.md
Raw
toolkit.validateslicecasereducers.md

Home > @reduxjs/toolkit > ValidateSliceCaseReducers

ValidateSliceCaseReducers type

Used on a SliceCaseReducers object. Ensures that if a CaseReducer is a CaseReducerWithPrepare, that the reducer and the prepare function use the same type of payload.

Might do additional such checks in the future.

This type is only ever useful if you want to write your own wrapper around createSlice. Please don't use it otherwise!

Signature:

export declare type ValidateSliceCaseReducers<S, ACR extends SliceCaseReducers<S>> = ACR & {
    [T in keyof ACR]: ACR[T] extends {
        reducer(s: S, action?: infer A): any;
    } ? {
        prepare(...a: never[]): Omit<A, 'type'>;
    } : {};
};
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment