TypeScript declaration file that allows using import with *.vue files. The primary use case is a bundler environment like webpack. The file itself consists of 4 lines; this package is just for convenience.
This package requires TypeScript 2 and Vue.js 2, which ships with new type definitions in the Vue.js package itself. Both must be installed separately in your project, which allows choosing a suitable version.
-
Install
npm install vue-typescript-import-dts --save-dev
-
Import (one of):
- Import this module before the import of a
.vuefile:import 'vue-typescript-import-dts' - ... or include it in the
typesfield of yourtsconfig.jsonto globally allow using import with.vuefiles in your project:
- Import this module before the import of a
{
"compilerOptions": {
"types": ["vue-typescript-import-dts"],
...Then, it is possible to import a *.vue file:
import Child from './child.vue'
Note: TypeScript will not type check, parse, or even verify the existence of the .vue file: this project only instructs the TypeScript compiler to assume the import of 'something' that ends with .vue succeeds and is a Vue object.
If you are using TypeScript 2 together with Vue.js 2, you might also be interested in
- vue-typescript-jest to test Vue.js components and TypeScript sources using Jest
- vue-jest-utils to simplify snapshot testing of Vue.js components using Jest and html2jade