definite assignment assertion

definite assignment assertionは、変数やプロパティが確実に初期化されていることをTypeScriptのコンパイラに伝える演算子です。

`strictNullChecks`と変数の初期化エラー

TypeScriptはコンパイラオプションstrictNullChecksがtrueのとき、初期化されていない変数を参照した際にエラーを出します。

ts
let num: number;
console.log(num * 2);
Variable 'num' is used before being assigned.2454Variable 'num' is used before being assigned.

ts
let num: number;
console.log(num * 2);
Variable 'num' is used before being assigned.2454Variable 'num' is used before being assigned.

変数の初期化が明らかに関数内で行われている場合でも、コンパイラは変数が初期化されていないとエラーを出します。

ts
let num: number;
initNum(); // 関数内でnumを初期化しているが…
console.log(num * 2);
Variable 'num' is used before being assigned.2454Variable 'num' is used before being assigned.function initNum() {
  num = 2;
}

ts
let num: number;
initNum(); // 関数内でnumを初期化しているが…
console.log(num * 2);
Variable 'num' is used before being assigned.2454Variable 'num' is used before being assigned.function initNum() {
  num = 2;
}

`strictPropertyInitialization`とプロパティの初期化エラー

TypeScriptでは次のコンパイラオプションの両方がtrueのとき、クラスのプロパティが初期化されていないとエラーを出します。

ts
class Foo {
  num: number;
Property 'num' has no initializer and is not definitely assigned in the constructor.2564Property 'num' has no initializer and is not definitely assigned in the constructor.}

ts
class Foo {
  num: number;
Property 'num' has no initializer and is not definitely assigned in the constructor.2564Property 'num' has no initializer and is not definitely assigned in the constructor.}

TypeScriptコンパイラは、プロパティ定義またはconstructorでプロパティが初期化されるかを見ています。しかし、constructor以外のメソッドで初期化されるところまでは追いかけません。たとえば、次例のnum3は実際は初期化されるものの、コンパイラは初期化がされていないと警告を出します。

ts
class Foo {
  num1: number = 1; // 初期化している
  num2: number;
  num3: number;
Property 'num3' has no initializer and is not definitely assigned in the constructor.2564Property 'num3' has no initializer and is not definitely assigned in the constructor. 
  constructor() {
    this.num2 = 1; // 初期化している
    this.initNum3(); // num3を初期化している
  }
 
  initNum3() {
    this.num3 = 1;
  }
}

ts
class Foo {
  num1: number = 1; // 初期化している
  num2: number;
  num3: number;
Property 'num3' has no initializer and is not definitely assigned in the constructor.2564Property 'num3' has no initializer and is not definitely assigned in the constructor. 
  constructor() {
    this.num2 = 1; // 初期化している
    this.initNum3(); // num3を初期化している
  }
 
  initNum3() {
    this.num3 = 1;
  }
}

definite assignment assertionを使う

変数やプロパティの初期化が確実に行われていることをコンパイラに伝えるには、definite assignment assertion(デフィニット・アサイメント・アサーション)を使います。変数宣言の変数名やプロパティ名のあとに!を書きます。

ts
let num!: number;
//     ^definite assignment assertion
initNum();
console.log(num * 2); // エラーにならない
function initNum() {
  num = 2;
}

ts
let num!: number;
//     ^definite assignment assertion
initNum();
console.log(num * 2); // エラーにならない
function initNum() {
  num = 2;
}

ts
class Foo {
  num!: number;
  // ^definite assignment assertion
}

ts
class Foo {
  num!: number;
  // ^definite assignment assertion
}

definite assignment assertionの意味は「確実な代入の表明」です。この変数はこの型であることが確実であることをTypeScriptコンパイラに伝えるということです。

非Nullアサーション

別の方法として、非Nullアサーション(non-null assertion)を使う方法もあります。この場合は、変数を参照するコードにて、変数のあとに!を書きます。

ts
let num: number;
initNum();
console.log(num! * 2); // エラーにならない
//             ^非Nullアサーション
function initNum() {
  num = 2;
}

ts
let num: number;
initNum();
console.log(num! * 2); // エラーにならない
//             ^非Nullアサーション
function initNum() {
  num = 2;
}

より安全なコードを書くには

definite assignment assertionと非Nullアサーションは、型の安全性を保証する責任をコンパイラからプログラマに移すものです。そして、型に関してはコンパイラより人間のほうがミスをしやすいです。なので、こうしたアサーションはできる限り使わないほうが安全性は高いです。

たとえば、上の例であればinitNumの戻り値をnumに代入するほうが、より安全なコードになります。

ts
let num: number;
num = initNum();
console.log(num! * 2);
function initNum() {
  return 2;
}

ts
let num: number;
num = initNum();
console.log(num! * 2);
function initNum() {
  return 2;
}

他にも、numが数値型であるかを型ガードでチェックする方法もあります。

ts
let num: number | undefined;
initNum();
// 型ガード
if (typeof num === "number") {
  console.log(num * 2);
}
function initNum() {
  num = 2;
}

ts
let num: number | undefined;
initNum();
// 型ガード
if (typeof num === "number") {
  console.log(num * 2);
}
function initNum() {
  num = 2;
}

このようにアサーションに頼らない方法はないかを先に検討することをお勧めします。その上で、どうしてもというときにアサーションを使うようにしましょう。フレームワークやライブラリの都合で、やむを得ない場合もあります。

学びをシェアする

・definite assignment assertionは、変数初期化が確実であるとTypeScriptのコンパイラに伝える
・変数名のあとに!を書く
・型安全の責任をコンパイラからプログラマに移すものなので、使わない方法を先に検討する
・どうしようもないときに使う

『サバイバルTypeScript』より

この内容をツイートする

📄️ strictNullChecks

null・undefinedのチェックを厳しくする

📄️ strictPropertyInitialization

クラスプロパティの初期化を必須にする

strictNullChecksと変数の初期化エラー​

strictPropertyInitializationとプロパティの初期化エラー​

definite assignment assertionを使う​

非Nullアサーション​

より安全なコードを書くには​

学びをシェアする

関連情報​

📄️ strictNullChecks

📄️ strictPropertyInitialization

`strictNullChecks`と変数の初期化エラー

`strictPropertyInitialization`とプロパティの初期化エラー

definite assignment assertionを使う

非Nullアサーション

より安全なコードを書くには

関連情報