@outcome-co/vuedts

Generate TypeScript declaration files for .vue files

Usage no npm install needed!

<script type="module">
  import outcomeCoVuedts from 'https://cdn.skypack.dev/@outcome-co/vuedts';
</script>

README

vuedts-js

Continuous Integration version-badge

This repository is fork from https://github.com/kahirokunn/vuetype that adds support for Vue 3, but removes Class style components.

Generate TypeScript declaration files for .vue files

Installation

You can use vuedts command after exec one of following commands.

$ npm install --global @outcome-co/vuedts # npm
$ yarn global add @outcome-co/vuedts # yarn

Usage

Specify the directory that includes your .vue files as the 2nd argument of vuedts command. Note that the .vue files should have TypeScript code (in <script lang="ts"> element).

vuedts src/components

Then .vue.d.ts file corresponding .vue file will be output. So you can import each .vue component with concrete type declaration! This would help your editor inspect.

Watch mode

You can enable watch mode by adding --watch (shorthand -w) flag. In the watch mode, vuedts watches update of .vue files and generates declaration files when the .vue files are updated.

vuedts --watch src/components

License

MIT