Nonstick Pancake Maker

    @kahirokunn/vuedts
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.4 • Public • Published

    vuedts

    This repository is fork from https://github.com/ktsn/vuetype Because that repository has not maintained now.

    npm version Build Status

    Generate TypeScript declaration files for .vue files

    Sample Repository

    https://github.com/kahirokunn/book-management/pull/75

    Installation

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

    $ npm install --global @kahirokunn/vuedts # npm
    $ yarn global add @kahirokunn/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.

    For example, if there is the following component:

    <template>
      <div>{{ message }}</div>
    </template>
    
    <script lang="ts">
    import Vue from 'vue'
    import Component from 'vue-class-component'
    
    @Component
    export default class MyComp extends Vue {
      message = 'Hello'
    }
    </script>

    You will acquire the following declaration file:

    import Vue from 'vue';
    export default class MyComp extends Vue {
        message: string;
    }

    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

    Install

    npm i @kahirokunn/vuedts

    DownloadsWeekly Downloads

    373

    Version

    1.3.4

    License

    MIT

    Unpacked Size

    39.2 kB

    Total Files

    27

    Last publish

    Collaborators

    • k-okina