Skip to content

Officially document TS support #5158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
markerikson merged 1 commit into from
Dec 8, 2025
+37 −1
Merged

Officially document TS support #5158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/introduction/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,24 @@ yarn add react-redux

The package includes a precompiled ESM build that can be used as a [`<script type="module">` tag](https://unpkg.com/@reduxjs/toolkit/dist/redux-toolkit.browser.mjs) directly in the browser.

## Requirements

### TypeScript

Redux Toolkit follows [DefinitelyTyped's policy](https://github.com/DefinitelyTyped/DefinitelyTyped#support-window) of supporting TypeScript versions released within the past two years. As of RTK 2.11, this means we support:

| RTK Version | Minimum TypeScript |
| ----------- | ------------------ |
| 2.x | 5.4+ |
| 1.9.x | 4.7+ |

<details>
<summary>Using an older TypeScript version?</summary>

If you're unable to upgrade TypeScript, RTK may still work with older versions, but you may encounter type errors or missing type inference. We strongly recommend upgrading to take advantage of improved type safety and developer experience.

</details>

## What's Included

Redux Toolkit includes these APIs:
Expand Down
2 changes: 1 addition & 1 deletion docs/rtk-query/usage-with-typescript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This page provides details for using APIs included in RTK Query with TypeScript

:::info

**We strongly recommend using TypeScript 4.1+ with RTK Query for best results.**
RTK Query [supports TS versions released within the last 2 years](../usage/usage-with-typescript.md).

If you encounter any problems with the types that are not described on this page, please [open an issue](https://github.com/reduxjs/redux-toolkit/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) for discussion.

Expand Down
18 changes: 18 additions & 0 deletions docs/usage/usage-with-typescript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,24 @@ If you encounter any problems with the types that are not described on this page

:::

:::tip TypeScript Version Requirement

Redux Toolkit follows [DefinitelyTyped's policy](https://github.com/DefinitelyTyped/DefinitelyTyped#support-window) of supporting TypeScript versions released within the past two years. As of RTK 2.11, this means we support:

| RTK Version | Minimum TypeScript |
| ----------- | ------------------ |
| 2.x | 5.4+ |
| 1.9.x | 4.7+ |

<details>
<summary>Using an older TypeScript version?</summary>

If you're unable to upgrade TypeScript, RTK may still work with older versions, but you may encounter type errors or missing type inference. We strongly recommend upgrading to take advantage of improved type safety and developer experience.

</details>

:::

## `configureStore`

The basics of using `configureStore` are shown in [TypeScript Quick Start tutorial page](../tutorials/typescript.md). Here are some additional details that you might find useful.
Expand Down