a500ede755
* Add note about npx caching and link to #6119 It is necessary to uninstall any version that was previously installed for the typescript flag to work when using npx. * Use proper casing for TypeScript Co-Authored-By: TaylorBriggs <TaylorBriggs@users.noreply.github.com>
2.0 KiB
id, title
| id | title |
|---|---|
| adding-typescript | Adding TypeScript |
Note: this feature is available with
react-scripts@2.1.0and higher.
TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
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
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.js to 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 withnpm 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: If you are currently using create-react-app-typescript, see this blog post for instructions on how to migrate to Create React App.
Note: We recommend using VSCode for a better integrated experience.
Note: Constant enums and namespaces are not supported.