Skip to content

Instantly share code, notes, and snippets.

@phryneas

phryneas/index.md

Last active Apr 24, 2020
Embed
What would you like to do?
api-documenter test

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> 

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> 

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> 

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> 

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> 

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>

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>

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>;
{
"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"
},