LoginSignup
14
9

More than 3 years have passed since last update.

Vue Typescript の書き方 (Decoratorあり、なし)

Last updated at Posted at 2019-10-28

Vue で Typescript 使う意義

一般的に型定義をもっとも使いたい箇所は インターフェイス部分だと思います。
Vue でいうと Props にあたります。
Props には動的型チェックがついており、定義しておくと動作時に型チェックをしてくれます。

ただこの機能は動かなさないと型チェックができません。
またVue Props はオブジェクトや配列など中身までチェックする複雑なデータの型チェックがあまり得意ありません。

(個人的にはもともと Vue についている動的チェックで十分ではないかと思ったりします。)

ただ Typescript の書き方がいくつかあり、Vue の公式ドキュメントの Typscript の項目はあまり情報量がないので、Qiita にも書いてみます。(他に結構書いてるかたいることにあとで気づいた・・)

Vue Typescript で Decorator を使う使わないの選択

Decorator 使わないパターン

こちらは JS とほとんど変わらない作りになっています。
props の型チェックは、vue の Runtime のみになります。

<template>
    <div>
        <div class="greeting">Hello {{name}}{{exclamationMarks}}</div>
        <button @click="decrement">-</button>
        <button @click="increment">+</button>
    </div>
</template>

<script lang="ts">
import Vue from "vue";

export default Vue.extend({
    props: {name: {type:String, defalut:"" }, 
            initialEnthusiasm: {type:Number, defalut:0 }
           },
    data() {
        return {
            enthusiasm: this.initialEnthusiasm,
        }
    },
    methods: {
        increment() { this.enthusiasm++; },
        decrement() {
            if (this.enthusiasm > 1) {
                this.enthusiasm--;
            }
        },
    },
    computed: {
        exclamationMarks(): string {
            return Array(this.enthusiasm + 1).join('!');
        }
    }
});
</script>

こちらを参考にしました。

Decorator を使うパターン

<template>
  <div>
    <input v-model="msg">
    <p>prop: {{propMessage}}</p>
    <p>msg: {{msg}}</p>
    <p>helloMsg: {{helloMsg}}</p>
    <p>computed msg: {{computedMsg}}</p>
    <button @click="greet">Greet</button>
  </div>
</template>

<script lang="ts">
import Vue from 'vue'
import Component from 'vue-class-component'

@Component
export default class App extends Vue {
  // 型は TypeScript コンパイル字にチェック、デフォルト値を設定
 // Props 変更することはないので readonly を指定
  @Prop({ default: '' }) readonly propMessage: String

  //data の定義
  msg = 123
  helloMsg = 'Hello, ' + this.propMessage

  // lifecycle の定義
  mounted () {
    this.greet()
  }

  // computed の定義
  get computedMsg () {
    return 'computed ' + this.msg
  }

  // method の定義
  greet () {
    alert('greeting: ' + this.msg)
  }
}
</script>

こちらを参考にしました。

どっちが良い?

ケースバイケースだと思います。

Decoratorを使わないパターンが良いケース

  • Decorator を学習している時間がない時や、これから Vue を使い始めるエンジニアが多い場合 Docorator を使うとコード見た目が結構違うので公式ドキュメントからは学びづらいと思います。

Decoratorを使うパターンの方が良いケース

  • Vue の Props には形チェックがついてますが、動かさないとチェックできません。
  • Object や Array の中身までチェックしたい時は、Typescript の方がやりやすいと思います。

どっちを使う?

2019年時点では 公式のドキュメントが薄いので、フロントエンドをバリバリやっているメンバー以外に使ってくださいと展開するには参考情報が少なく、新規プロジェクトのようなお手本となるコードが少ないケースでは、自分だったら Decorator がないパターンを採用すると思います。

最終的には合う合わないで決めるのが良いと思います。

時間やメンバーのスキルに余裕があるならせっかく TSを導入するなら、Decorator を使ってみても良いとかな(?)とも思います。

[追記]
自分は当初 Decorator を使わないと props の型が付けれないと思っていたのですが、
こちらの記事をみてそうでもないとわかったので、Vue.extend で十分な気がしています。

有益な情報源

参考に掲載した下記のサイトは TypeScript を使う上で道標となると思います。
おおよそのパターンの把握はできると思います。

14
9
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
14
9