Skip to content

feat(create-app): improve client types #3214

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
patak-cat merged 4 commits into from
May 22, 2021
Merged

feat(create-app): improve client types #3214

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c974dad
chore(create-app): remove tsconfig.types
fi3ework Apr 29, 2021
36428f9
fix: change all name to `vite-env.d.ts`
fi3ework May 22, 2021
aa27d9e
docs: add d.ts method to use client types
fi3ework May 22, 2021
cbb6b16
docs: make add d.ts default
fi3ework May 22, 2021
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
Prev Previous commit
docs: make add d.ts default
  • Loading branch information
@fi3ework
fi3ework committed May 22, 2021
commit cbb6b16bcf46811b0fdd59e8428330159457f0fe
14 changes: 7 additions & 7 deletions docs/guide/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ Note that because `esbuild` only performs transpilation without type information

### Client Types

Vite's default types are for its Node.js API. To shim the environment of client side code in a Vite application, add `vite/client` to `compilerOptions.types` of your `tsconfig`:
Vite's default types are for its Node.js API. To shim the environment of client side code in a Vite application, add a `d.ts` declaration file:

```typescript
/// <reference types="vite/client" />
```

Also, you can add `vite/client` to `compilerOptions.types` of your `tsconfig`:

```json
{
Expand All @@ -48,12 +54,6 @@ Vite's default types are for its Node.js API. To shim the environment of client
}
```

Also, you can add a `d.ts` declaration file:

```typescript
/// <reference types="vite/client" />
```

This will provide the following type shims:

- Asset imports (e.g. importing an `.svg` file)
Expand Down