Note: this feature is available with
[email protected]and higher.
To start a new Create React App project with TypeScript, you can run:
npx create-react-app my-app --typescript # or yarn create react-app my-app --typescript
If you've previously installed
npm install -g create-react-app, we recommend you uninstall the package using
npm uninstall -g create-react-appto ensure that
npxalways uses the latest version.
To add TypeScript to a Create React App project, first install it:
npm install --save typescript @types/node @types/react @types/react-dom @types/jest # or yarn add typescript @types/node @types/react @types/react-dom @types/jest
Next, rename any file to be a TypeScript file (e.g.
src/index.tsx) and restart your development server!
Type errors will show up in the same console as the build one.
To learn more about TypeScript, check out its documentation.
Note: If your project is not created with TypeScript enabled, npx may be using a cached version of
create-react-app. Remove previously installed versions with
npm uninstall -g create-react-app(see #6119).
Note: You are not required to make a
tsconfig.jsonfile, one will be made for you. You are allowed to edit the generated TypeScript configuration.
Note: We recommend using VSCode for a better integrated experience.
Note: Constant enums and namespaces are not supported.