Typescriptのスーパータイプとサブタイプについて

# はじめに
この記事は、[JSL(日本システム技研) Advent Calendar 2021](https://qiita.com/advent-calendar/2021/jsl) の記事です。
Typescriptを書いていると、代入できるつもりが型エラーになったりしたことが何度かありました。この辺の「なんとなく」なところを解剖していこうという内容になります（なっているはずです）。

# 環境
- https://www.typescriptlang.org/play `v4.5.2` 
    - Typescriptを試したいときにオススメです
    - この記事内のコードは[こちらのリンク](https://www.typescriptlang.org/play?#code/LAKFHpwAgRkA69SgMYHsB2BnALlAtgUygF4oAiA0gbkREj0IB56B5AJwE0UBXZdbFjtwBcZClAA+ZAJ7dSxetVrQCUJgTacuqqNla9MOXSN0BLNAHN56wV0V0Va-Bu7bd2gIb7+7ke7RT5XUUIaEBWhkA1hkB+hkAShkB1hkBrBkArwMBquMAkhkBjuUBTRUBzBkBZBkArBkARBi8cGS4RUjK5EmtNYLAlKAAmBAa6QCqGcMAOhkByhkB6hkAJhkBo9UA7BkAWDUAIFRKodwAjeQBvUCgZkQBydzWAGmWoWfXZtdAAX3q6WMBbhkBFhkAxhkBihj2oeMAi1MB1BkAzBkBOhkAfhivvmNi4ymIFQBhmsyaIgWqx0WFYZnMlD2xjhCIkUDQXFws3wrCgx3kczs0Dm8UAGtqACnVXkVLrc7oAZBkA33KAeEMgdM5kgoTDTBYkftYfDeVAkAB+FGCywEkhEkIzfyAewZABaK7xGox+fwB7MhcoC0tmZ2gtPu9MA6RqACQZANEMI2yEQB8XygCiGLJ5Irs2YAEy5PgFCL54t9UE9Pos+MJ+po52uxsAmvKAByU2SC+Dh+dD+TzJWGDVBnoAHUxGgFR9HPywCj+oBAyMAAOaAOXlAApp8VAWCkAAdCABBABCAGEACLyABK+FQrHdDA2a3Ra0O46QY8ka3d22D5gAfIpQfwMFiADL4CxYAAW8gAFI33FIADYodxBgAKJiQAGsGO3u1soKPx4clwBKYhLqAn89L3dAA6dxgLPHdzH3KAAGp-1PC8r2A2ZwMg-dVyTcEkCDZ8exIaFvVHV9+QnBdOTfadXyDOcx1OUAN1wbddz3Q8OXdL9FAYpioJYuYOLdbCmkWGEiORN9Dlfci1kowN1nnfFOK3NDeNmQT+MafJAB0GQBpBkAF7dAFLjQBCO0ATQZJkAAwZAEUGQA+fW0wAYhneV5AD8GQAxBkAMgJ6KU5jDwI9ZNmIg4yPWGTqPk451IjaAAGZWllQAihlCb5AHaGQBzhkAZ4Y8iteVbTiQALBnVf44kADwYRkAfwZplqbhtTWAgZzfMoxxIar8DWYkoGy2JQAqrghPcDA3xq1r8s1EAup6vr0yzQAwBPiQBABkASwZAEMGQBIhniQAghkAJyjAGV9alCkAQkdnkAIflVUK+KkrS4yLUAZQYcvlPJHMAbQZAGSGTqnBsMaMSxHFWCzQB2fXzeJjIdQAcowsl7nG6mY+q4NB7zQFAAHc0Ehj7sVxLNOl6QYgWyVbABgVQANBmmcwD3wqBzHWcwFz3dY91owbfgKjqQGJ5HoXJxcFNAFneqgNn-SFamOckTFUbxOjGnarmDx5vnFyRQWJqgEx+clLNABNYkZADW5QAuuSl1myZEEWvvllXObaaAABYYsaEHABcvaZdGYWYACsRH7Qdh3TV90z-fDxZoNccHdQI4Sd52AG1SHdUgAF0s3TEZ2tSQBahm+eJXkAfQZJmmfAADM3YHFAhxHZrx1zhcfcWf3GmvdxWCwEx3DPQANuQsjPAAknB3Q5d2v68bs8RF7hum4Yd2i891ELG9yfl193nq+md0hJIR2e7r4ez0j6O49AIA)を踏んでいただくとコピーされますので、気になるところを変更したりして試していただけると面白いかもしれません

# 本編

## 1. 「スーパータイプ」と「サブタイプ」
例として、 `const me = "me"; ` を基準にして考えてみましょう。
変数 `me` は、文字列の"me"型として定義されていますね。（Typescriptのバージョンが低いとただのstring型として扱われるので注意）

![SS 2021-12-05 20.29.37.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/934982f9-4d96-ffc0-aa99-0766c7d2cfd6.png)

で、これを別の型の変数として代入してみましょう。

![SS 2021-12-05 20.37.37.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/899c8323-506f-32c9-57df-e764f4dac4d4.png)

上記では `"me" | "you"` ・ `string` ・ `any` の三種類に `me` を代入しています。この3つはいずれも「 `me` < `X`」という関係性、つまり `me` の「スーパータイプ」となります。
当然、スーパータイプに対しては自身を代入することが可能なので型エラーは起きていませんね。
さらに言うと、 **上の変数に対して下の変数**が「スーパータイプ」になっているので、こんな代入も可能です。

![SS 2021-12-05 20.50.34.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/bc9f4716-21b8-5605-bbbc-8ccd43eb933b.png)

じゃあ「サブタイプ」は何かと言えば逆の立ち位置のもの、上記に倣うなら**下の変数に対して上の変数**が「サブタイプ」となります。
当然、サブタイプに自身を代入することはできません。

![SS 2021-12-05 21.03.14.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/11b74059-6446-b66f-8e13-9167ee0b3d58.png)

`"you"` は `meOrYou` に代入できる（スーパータイプ）なのに対し、 `you` に `meOrYou` は代入できませんね（サブタイプ）。エラーくんが「 `"me"` が割り当てられないﾖ！」とおっしゃっている通りです。

このようにして、Typescriptは型の整合性を保っているわけです。


## 2. オブジェクト型の場合
1章ではリテラル型（stringやnumber）のみを例に取って説明しましたが、オブジェクト型が入ってくると少々複雑になります。
例として、 `ab` ( `{ a: string; b: string }` 型）を自身として扱うことにしましょう。
まずは `ab` のスーパータイプについて考えてみます。

![SS 2021-12-05 21.29.00.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/34c194c6-8ad6-7119-7aa3-6b079aa07181.png)

オブエジェクト型のスーパータイプになるのは大体この3パターンです。
なんとなく「プロパティ増やせばスーパータイプになりそう」な気がするかもしれません（当社比）が、**プロパティが増えるということは制限がキツくなるということ** なので、 `?` を付けて任意プロパティにしない限り「サブタイプ」という扱いになってしまうのです。

![SS 2021-12-05 21.35.21.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/259919b8-0f6f-9341-4ca9-721de3007c67.png)

「`d` がないやんけ！」ってエラーくんも騒いでますね（そりゃそう）
逆に、自身のプロパティが余剰である場合はちゃんと代入できます。

![SS 2021-12-05 22.11.48.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/9d9e98f7-969b-0389-9a7d-5221a73c6d8a.png)

関数の引数なんかは、必要最低限のプロパティを持ったオブジェクト型にしてあげると都合がいいので、すこし気を使ってあげると良いかもしれませんね。

![SS 2021-12-05 22.24.30.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/094d243a-1827-d183-6f69-e87dda6a5e64.png)

直接渡す場合だけエラー出るのはナゼ…？ :thinking: 

## 3. アサーションについて
Typescriptは `as` で型アサーションをすることができますが、わりかし「アサーションしようとするとエラーになる」ことがありますよね？
スーパータイプ・サブタイプについて理解できると、これの謎が解けると思いますので一緒に紹介します。
結論から言えば、アサーションはサブタイプかスーパータイプにしかできません。

![SS 2021-12-06 9.24.27.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/eca1c1cb-7cd3-f5cf-5c86-fddac8343045.png)

逆に言えば、どちらでもない赤の他人にはアサーションすることができないようになっています。


![SS 2021-12-06 9.27.51.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/46e81e1d-1ffd-e59c-1765-9d4eb8ab2084.png)

ただ、エラーくんも言っている通り、1度 `unknown` や `any` といった最上位のスーパータイプへのアサーションを経由することですり抜ける事も可能です。…が、余程のことがない限りやめておいたほうがいいでしょう。

![SS 2021-12-06 9.32.16.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/b711d48c-f25a-443b-084b-35cd598332aa.png)

オブジェクト型の場合でもこの関係は同じですので、基本的には **自身と同じプロパティを１つでも持っている型** へならアサーション可能なわけです。

![SS 2021-12-06 10.03.33.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/05dc4b2e-7d90-d67d-ce7f-f157428c8138.png)

ですが例外もありまして、自身も持っているプロパティの型が赤の他人の場合は、オブジェクト型としても赤の他人扱いとなります。

![SS 2021-12-06 10.07.38.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/b7f52007-0025-038e-a3f4-dbb0b71a377a.png)

ここだけややこしいので注意が必要ですね。

## 4. おまけ：「バベルの図書館 :books: 」
結構ガチガチに見えるTypescriptの型ですが、エラーをすり抜けてしまう例もあるので紹介します。
それが「キーが `string` 型のオブジェクト型」です。めっちゃよく見るやつですよね。

![SS 2021-12-05 21.47.06.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/c9fe9973-026f-d6bb-317a-73b7845a8106.png)

一見大丈夫そうに見えますが、空オブジェクトを代入できてしまっている(空オブジェクト型がサブタイプと扱われてしまっている)せいで `d` を参照した時に `string` 型と推論されてしまっています。本来は空オブジェクトも許容できてしまっているわけですから `string | undefined` と推論されるべきです。そうでないと、 `undefined` である `d` にアクセスした時、例外エラーが発生してしまうことに型エラーで気づくことができません…おぉ怖い怖い…。

ちなみにキーがstringのサブタイプであればちゃんと防げるんです。キーのプロパティが全て指定されてないとTypescriptが判断できてます。

![SS 2021-12-05 21.55.54.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/0ca2cdbf-c6ee-b55a-6acf-64f9ba75167b.png)

が、**キーがstringの場合** は **プロパティが無限大** なのでTypescriptが正しく判断できない…というよりそもそも正しく定義することが不可能なのです。
こういうヤバイ型はなるべく使うのを避けましょう。
どうしても使わざるを得ない場合は `Partial` で全てのプロパティを任意にしちゃいましょう。こうすれば辻褄があって安全です。

![SS 2021-12-05 22.06.44.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/252036/238f7e3e-13d5-3d10-07e6-ec36beffd937.png)


# おわりに
Typescriptで、「代入しようとしたら型エラーが出たけどよく分からない」「関数の引数を渡そうとすると型エラーになって詰み」みたいなものは、この辺りを理解しているとすんなり解決する場合があります。
面倒だからと `as any` する前にちょっとでも思い出していただければ幸いです（自戒）

# 追記

> 直接渡す場合だけエラー出るのはナゼ…？ :thinking:

まず、変数を定義する時は余剰プロパティを許さないという仕様があります。直接渡すということは、その場で定義するのと同義らしくエラーが出るようです。

> おまけ：「バベルの図書館 :books: 」

Partial<T> にするだけでは配列などに対処できません。なので以下のコンパイラオプションを入れることを強くオススメします！

https://typescriptbook.jp/reference/tsconfig/nouncheckedindexedaccess