メインコンテンツまでスキップ

TypeScript

TypeScript特有の組み込み型関数
Type challenge

TypeScript導入にあたって​

LINE参考

JavaScriptを熟知した人間にとっては、静的型の制限があることによりJavaScriptでは簡単に実現できていた設計がTypeScriptでは困難になるという場面がある。

コンパイル時評価 or コンパイル時計算​

TypeScript のコンパイル時計算はどこまでできるのか？

TypeScriptはJavaScriptへのトランスパイル時に実行時に振る舞いを変えるような最適化や評価は行いない。
そのため、コードがJavaScriptにトランスパイルされたとしても、style1とstyle3の比較やオブジェクトの作成はランタイム時（ブラウザやNode.jsでコードが実際に実行される時）に行われる。

TypeScriptの主要な役割は型チェックにある。
これはコンパイル時（具体的にはトランスパイル時）に行われ、型の不整合や他の型関連のエラーを検出できる。　　 これにより、実行時のエラーを減少させ、コードの品質を向上させることが期待できる。
しかし、TypeScriptはJavaScriptへのシンプルなトランスパイルを目指しており、コンパイル時の最適化や変数の評価、インライン化などの高度な最適化は行いません。そのため、TypeScriptでの評価や計算は、トランスパイル後のJavaScriptコードが実際に実行される際（ランタイム）に行われます。 これはTypeScriptがJavaScriptのスーパーセットであり、結果として出力されるJavaScriptの振る舞いや性能を直感的に理解することを目指しているためです。

staticキーワードは評価されるのか​

JavaScriptやTypeScriptにおける static キーワードに関連するフィールドやメソッドは、そのクラスのインスタンスを生成しなくてもアクセスできるメンバーを示します。しかし、static が評価済みという意味ではない。

class MyClass {
    static staticValue = "This is a static value";

    static staticMethod() {
        console.log("This is a static method.");
    }
}

console.log(MyClass.staticValue); // This is a static value
MyClass.staticMethod(); // This is a static method.

上記の例では、MyClass の staticValue という静的フィールドと staticMethod という静的メソッドにアクセスしています。これらはインスタンス化せずとも直接アクセス可能です。 しかしこの staticValue の初期化や staticMethod の定義自体は、スクリプトが読み込まれて実行されるタイミング（ランタイム）で行われます。ですので、static キーワードが評価済みというわけではなく、実行時に評価されることを意味しています。 ただし、一部のJavaScriptエンジンやツールは、特定のパターンを検出して最適化を行うことがありますが、これはTypeScriptやJavaScriptの言語仕様に基づくものではありません。

overloadから型定義を取得する​

参考URL

TypeScript クラス内でアロー関数を使用する場合​

class ParentClass {
  // これはプロパティ
  //hoge : () => void = () => console.log("Hoge");
  // これはメソッド
  hoge() {
    console.log("Hoge");
  }
}

TypeScript（およびJavaScript）において、アロー関数で定義するとクラスのインスタンスプロパティとして扱われます。これは、関数が実際にはそのインスタンスのプロパティ値として保存されるためです。この挙動は、関数の this のスコープをクラスインスタンスに自動的にバインドする利点があります。したがって、アロー関数を用いたプロパティの定義は、特にイベントハンドラやコールバック関数として利用する場合に便利です。

クラス内のアロー関数をプロパティとして定義する例​

class ParentClass {
  // アロー関数をプロパティとして定義
  hoge: () => void = () => {
    console.log("Hoge from property");
  };

  // 通常のメソッド定義
  normalMethod() {
    console.log("Hoge from method");
  }
}

const instance = new ParentClass();
instance.hoge();         // "Hoge from property" が出力される
instance.normalMethod();  // "Hoge from method" が出力される

このコード例では、hoge はクラスのインスタンスを通じて呼び出すことができるプロパティとして定義されています。アロー関数を使うと、this が関数が定義された時点のコンテキスト（この場合はクラスのインスタンス）に永続的にバインドされるため、クラスの他のメソッドやプロパティに簡単にアクセスできます。これに対して、normalMethod は通常のメソッドとして定義されており、特に this の挙動に注意が必要な場合（例えばコールバックとして使用する場合など）は、適切にバインドするかアローファンクションを使用する必要があります。

TypeScriptのエラーハンドリング​

セオリーなerrorハンドリング

TypeScript には Java の throws のように関数が throw する例外を宣言する方法がないので、どのような例外が throw され得るかを知るにはコードを読むしかありません。 result型は確かにいいけど可読性がいいかと言われたら違う。 そのためこれが一番セオリーかも。プロジェクトに導入した。

TypeScriptは構造型​

参考URL

TSDoc​

参考URL

参考 URL集​

仕事ですぐに使える TypeScript 高度な型定義 URL TypeScript日本語ハンドブック typescript 型付テスト tsconfig.jsonを書くときはTSConfig Basesを使うと便利 TypeScriptで作るアノテーション これまとめる これもまとめる TypeScriptのモデル生成速度比較 Three.js TypeScript webpack（これいつかやりたいな）

TypeScriptでグローバルな型定義ファイルを用意する​

参考URL

.d.ts​

型定義ファイル (.d.ts) .d.ts ファイルは .ts と .js ファイルの間をつなぐブリッジ。

自作の型定義ファイル .ts or d.ts？​

自作の型定義ファイルに ".d.ts" と付けない方がいい TypeScriptで型定義用のファイルを作る際に、ライブラリが生成する型定義ファイルの名前にならって .d.ts と付けると、定義していない型がanyとして使えてしまい型チェック時にもエラーになりません。 よって .ts で宣言する。

named import と default import​

named importだと呼び出し側で名前を変更できなくなるため、基本named importの方がいい。

import した時に、TypeScriptの型定義がない場合取れる対策​

参考URL

  1. npm install --save-dev @types/package-name をためす
  2. 1がなければ、 declare module “package-name"; を含んだ .d.tsを自分で追加する

TypeScript ジェネリクスを書くチートシート​

参考URL

TypeScriptコンパイラについて​

参考URL

結論はTypeScriptの実行パフォーマンスはJavaScriptと同じ。
これを理解するには理解するべきことがある。

  • TypeScriptのランタイムはない
  • TypeScriptコンパイラは最適化しない。

TypeScriptにはランタイムがありません。どういうことかというと、TypeScriptを直接実行するエンジンがないということです。TypeScriptを開発しているMicrosoftのブラウザMicrosoft Edgeであっても、TypeScriptは実行できません。サーバーのNode.jsもそうです1。TypeScriptで書いたコードを実行するには、一度JavaScriptコードに変換する必要があります。そのため、TypeScriptのパフォーマンスは、コンパイル後のJavaScriptがどうなっているかで決まるわけです。

一般的にコンパイラは次の3つの仕事がある

  • ソースコードを解析し、問題点をチェックする
  • ソースコードを別の言語に変換する 以下のことはTypeScriptコンパイラは実行しない。
  • 最適化する
    • 実行速度が速くなるようにする
    • 少ないメモリで動くようにする
    • 少ない電力で済むようにする
    • 実行ファイルのサイズを小さくする

このうち、TypeScriptコンパイラがするのは上の2つです。3つ目の最適化はしません。TypeScriptコンパイラは、基本的に型に関する部分を消すだけで、それ以外の部分はほぼそのままJavaScriptに変換します。

TypeScript コンパイラ​

参考URL

TypeScriptのコンパイラにはECMAScript Modules（ES Modules = importやexport文のこと）をまとめる機能が提供されていません。そのため、ES ModulesのJSファイルをまとめるモジュールバンドラー（例：webpack、Rollup等）をTypeScriptと合わせて使うのが一般的です。

  • 役割 TypeScriptの構文を下位のECMAScriptに変換する TypeScript → ECMAScript

  • コンパイラが追う順番 ts → tsx → d.ts

  • デフォルトで追う@typesフォルダーとは デフォルトで対象範囲すべての@typesパッケージがコンパイルに含まれる。(node_modules/@types) typesRootsがtsconfig.jsonに指定されている場合はそのパッケージのみが対象となる。

TypeScript インデックスシグネチャを安全に使う​

インデックスシグネチャで特定の文字だけのIndexを扱う

動的に任意のプロパティを作成・使用したいときに使うかもしれないが、だいたいは Map などで代用ができる。

TypeScript 型定義集​

export class typeSampleModel {
    // プリミティブな型
    str: string;                              // 文字列
    num: number;                              // 数値
    boolean: boolean;                         // 真偽値

    // なんでもOKの any型(unknownはmethodが使えない)
    data: any;
    unknow: unknown;

    // オブジェクト型リテラル
    array: any[];                             // 配列
    strArray: string[];                       // 配列内に文字列
    numArray: number[];                       // 配列内に数値
    multiArray: string[][];                   // 多次元配列
    objectArray: {key: string}[];             // 配列内にオブジェクト

    object: {key: string};                    // オブジェクト
    arrayObject: {key: string[]};             // オブジェクト内に配列
    strKeyObject: { [s: string]: string };    // 任意の文字列キーを許容したオブジェクト
    numKeyObject: { [n: number]: string[] };  // 任意の数値キーを許容したオブジェクト

    constructor () {
        this.str = "A";
        this.num = 1138;
        this.boolean = true;
        this.object = { key: "A"};
        this.array = [ "A" ];
        this.strArray = [ "A", "B" ];
        this.numArray = [ 1, 2 ];
        this.multiArray = [ [ "A", "B" ], [ "C", "D" ] ];
        this.objectArray = [ { key: "A" }, { key: "B" } ];
        this.arrayObject = { key: ["A", "B", "C"] };
        this.strKeyObject = { "a": "A", "b": "B", "c": "C" };
        this.numKeyObject = { 1: ["a", "A"], 2: ["b", "B"] }
    }

    // 関数を示すFunction
    // 関数の戻り値がない場合に使うvoid
    var method: Function = (): void => {
        var a:number = 1;
    }
}

tsconfig.json​

サバイバルTypeScript tsconfigあらかた設定

  • tsconfig設定の種類の概念

具体的には、ディレクトリやモジュール解決に関する以下のような設定・概念が存在する。

プロジェクトディレクトリ outDir rootDir declarationDir baseUrl paths rootDirs typeRoots このうちoutDir, rootDir, declarationDirが出力に関する設定、baseUrl, paths, rootDirs, typeRootsが入力に関する設定となります。

  • プロジェクトディレクトリ

プロジェクトディレクトリは設定項目には存在せず、以下の項目が適用される

  1. tsconfig.jsonが使用される場合 →存在するディレクトリがプロジェクトディレクトリになる

コンパイラー処理実行時に設定ファイルが明示的に指定された場合は、そのファイルが存在するディレクトリとなります。 コンパイラー処理実行時にディレクトリが明示的に指定された場合は、そのディレクトリとなります。

  1. それ以外の場合 → カレントディレクトリ

※プロジェクトディレクトリは様々なディレクトリやファイル関連の設定に使用される基準のディレクトリとなります。そのため、入力ファイルや出力ファイルの場所を考える際はプロジェクトディレクトリの位置、ひいては設定ファイル(tsconfig.json)の配置場所もある程度意識する必要があります。

  • outDir この設定項目はコンパイル結果（JSファイル）を生成するディレクトリ（出力ディレクトリ）を表す outFile設定が存在する場合は指定できない。

  • rootDir

この設定項目は出力ファイルのディレクトリ構造を決定する際にのみ使用されます。具体的には、rootDir で指定されたディレクトリをベースに入力ファイルの相対パスを計算し、その相対パスを出力ディレクトリに適用してファイルを出力します。なお、rootDir はプロジェクトディレクトリを基準としたパスとして扱われます。

例: outDir が「dist」、rootDir が「src」である場合 → ファイル「src/hoge/Hoge.ts」は計算された相対パスが「hoge/Hoge.ts」になるので「dist/hoge/Hoge.js」にコンパイルされます。 /ne

  • typeRoots typeRoots設定はこれまで説明した設定項目と若干異なり、コンパイル時に自動的に型定義ファイル（.d.ts）を持つパッケージを読み込む際の検索パスを指定する。 ここへ指定されたディレクトリ下にあるパッケージ内の型定義ファイルが自動的に使用されます。 また、<reference types='...' /> ディレクティブでの型定義読み込みの検索パスとしても利用されます。 typeRoots設定に指定するディレクトリはプロジェクトディレクトリを基準としたパスになる。

※typeRootsに指定するディレクトリはパッケージの検索パスであるため、指定されたディレクトリには <subdir>/index.d.ts のようにサブディレクトリを伴ってファイルを設置するか、package.jsonのあるディレクトリ（パッケージディレクトリ）を置く必要があります。

なお、自動的に型定義を読み込むかどうかはtypes設定で制御されます。 types設定が「[]」（空配列）である場合は、typeRoots設定にかかわらず自動的な読み込みが行われません（「includes」に含めた場合や <reference types='...' /> ディレクティブで明示的に指定した場合を除く）


// プロジェクトにあるd.tsを見に行く
"typeRoots": ["~"],

アロー関数が連続しているのは共通処理をしたいためのカリー化​

参考URL

namespace 名前空間​

名前空間はグローバルな名前空間でJavaScriptのオブジェクトに単純に名前がつけられたもの。
namespace ではなくモジュールの仕組みを使う方がいい。
TypeScriptでゃnamespaceキーワードを使って名前空間を定義できるが、通常はより柔軟性の高いモジュールの仕組みを使うのが推奨されている（といってもファイルを分けるだけ）

  • namespaceが非推奨な理由 namespaceを使うと同じファイル内で階層化された名前空間を作ることができるが、あくまでその階層構造はグローバルに占有されている。 一方モジュールの仕組みを使うと、ファイル単位で名前空間のコンテキストを分けることができる（大きなプロジェクトであっても、適切な単位でモジュールを分割している限り、名前の衝突は本格的に発生しない。）

トリプルスラッシュ・ディレクティブMapped Typesの基本形は { [P in K]: T } です。 P は T の中で使える型変数です。このとき、​

Mapped Typesの基本形は { [P in K]: T }。 ※PはTの中で使える型変数

  • PはこのMapped Typeの引数型 (parameter type)
  • KはこのMapped Typeの制約型 (constraint type)
  • TはこのMapped Typeのテンプレート型 (template type)
/// <reference path="..." />

1つのXMLタグを含む1行コメントになる コメントの内容はコンパイラへの指令として使用される。

Tips​

  • interfaceで型を上書きしたい時 参考URL

TypeScript バリデーション種類​

zod

JSに型をつける​

アンビエント宣言から既存ライブラリがJSしかない場合につける方法

TypeScriptのアンビエント宣言 (Ambient Declarations) を行うと、既存のJavaScriptライブラリに型情報を付加できる。

この仕組みを利用すると、

  • サードパーティ製のJavaScriptライブラリ（npmパッケージ）や、自作のJavaScriptライブラリ（ただしTypeScript化はしたくないもの）をTypeScriptから使用する
  • jQueryなどのブラウザ上でロードされるライブラリをTypeScriptから使用する といったことが可能になる。

※要するにTypeScriptトランスパイラに対して、このオブジェクトはこういう型のものとして外から提供されているので、型チェックエラーを出さないでね、と知らせることができる。

さらに、VS Codeなどのエディターを使用している場合は、アンビエント型宣言があることにより、エディター上での補完入力ができるようになります。

DefinitelyTyped​

@typesスコープを管理しているDefinitely Typedは、Microsoftから支援を受けているものの、Microsoftの脆弱性報奨金制度におけるセーフハーバーの対象ではない。

@typesで提供されているライブラリ yarn add @types/xxx

参考URL

Ambient Module 宣言で overload する​

参考URL

ライブラリが知ることのできない（自身のプロジェクト固有の定義）型をライブラリのルートに注入し行き渡らせる手法 interface宣言結合を利用したテクニックであり、さまざまなライブラリ型定義でも採用されている。

Uncaught (in promise)​

リファレンス

以下の場合が起こる。そしてブラウザでハンドリングができる。

window.addEventListener('unhandledrejection', function(event) {
  // イベントオブジェクトは2つの特別なプロパティを持っています:
  alert(event.promise); // [object Promise] - エラーを生成した promise
  alert(event.reason); // Error: Whoops! - 未処理のエラーオブジェクト
});

new Promise(function() {
  throw new Error("Whoops!");
}); // エラーを処理する catch がない

TypeScript コンパイラ種類表​

ts-node​

tsファイルをjsファイルにコンパイルすることなく実行する。 ts-node のデフォルトでは、指定ファイルと依存関係にないファイルは読み込んでくれない。

オプション

# 型チェックを行わず、トランスパイル(ts->js)のみ行う
# 高速な起動が可能
-T, --transpile-only

# tsconfig.ts のパスを指定できる
# 1つのプロジェクト内で複数の tsconfig.ts を使用したい時に便利
-P, --project <path>

# 指定ファイルと依存関係にないファイルは読み込んでくれない。
# 起動時に--filesオプションを付与すれば読み込んでくれる
# https://zenn.dev/ryo_kawamata/articles/ts-node-my-types
--files

ts-node-dev​

tsファイルをjsファイルにコンパイルすることなく、起動でき、さらに監視モードで素早く再起動が使用できる。
nodemonよりts-node-devのほうが大幅に再起動の速度が早いと公式に記載がある。

タイプガード(Type Guard)​

参考URL

Type assertions（キャスト）Type assertionsを使うと、実際のデータがどうであろうが強制的に型情報を書き換えてしまうため、有り難いTypeScriptの型チェックをすり抜けてしまう。TypeScriptではType assertionを使う代わりに実行時型チェックを強制するType Guardという仕組みがある。

undefinedなどを取り除く​

時間がある時まとめる ユーザ定義のガード こっちのが参考になるのかも

any vs unknown​

参考URL

anyはmethodが使えるが、unknownはmethodが使えないため少しだけ保守性があがる。

!(エクスクラメーション/感嘆符: かんたんふ)​

プログラマがコンパイラに対して、この変数はundefinedやnullになることはありません、と教える記述。

演算子​

in演算子​

is演算子​

参考URL

「is演算子」について取り上げます。is演算子は、User-Defined Type Guards(ユーザ定義型ガード)と呼ばれる機能で使われて、型を絞り込みたいシーンで活用できます。

unknown型やany型、Union型の型の絞り込みを行える。

keyof演算子​

参考URL

keyofはオブジェクト型からプロパティ名を型として返す型演算子です。 たとえば、nameプロパティを持つ型に対して、keyofを使うと文字列リテラル型の"name"が得られます。

type Person = {
  name: string;
};
type PersonKey = keyof Person; // type PersonKey = "name"

Null合体代入演算子(??=)​

参考URL

TypeScript4.0以降で使用可能。左辺がnullまたはundefinedの場合に代入する。 ※左辺がnullまたはundefined以外のfalsyな値の場合（''や0）代入されない

const pilot = { name: null };

pilot.name ??= "shinji";
console.log(pilot.name); //

インデックス型 (index signature)​

参考URL

TypeScriptで、オブジェクトのフィールド名をあえて指定せず、プロパティのみを指定したい場合があります。そのときに使えるのがこのインデックス型（index signature）

let obj: {
  [K: string]: number;
};

Mapped Types​

参考URL

Mapped Typeとは、あるオブジェクトのプロパティ名を利用して新しい型を作り出す機能

Indexed Access Types​

参考URL

TypeScriptのインデックスアクセス型(indexed access type)は、プロパティの型や配列要素の型を参照する方法を提供します。

type A = { foo: number };
type Foo = A["foo"]; // type Foo = number

Conditional Types​

Conditional Types

TypeScript 2.8で導入された。
型定義における条件分岐（三項演算子と同じ）

type MyCondition<T, U, X, Y> = T extends U ? X : Y;
に最終更新