Skip to content
This repository has been archived by the owner on Feb 23, 2022. It is now read-only.

TypeScript declaration file that allows using 'import' with *.vue files

License

Notifications You must be signed in to change notification settings

locoslab/vue-typescript-import-dts

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
Stephan Wagner
Apr 16, 2018
1defc85 · Apr 16, 2018

History

26 Commits
Apr 16, 2018
Apr 16, 2018
Oct 11, 2016
Aug 29, 2016
Apr 16, 2018
Apr 16, 2018
Jul 27, 2017
Apr 16, 2018
Apr 16, 2018

Repository files navigation

vue-typescript-import-dts Build Status npm version

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.

Usage

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.

  1. Install

    • npm install vue-typescript-import-dts --save-dev
  2. Import (one of):

    • Import this module before the import of a .vue file: import 'vue-typescript-import-dts'
    • ... or include it in the types field of your tsconfig.json to globally allow using import with .vue files in your project:
{
    "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.

Shameless Plug

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

License

MIT

About

TypeScript declaration file that allows using 'import' with *.vue files

Resources

License

Stars

Watchers

Forks

Packages

No packages published