Last updated at
warning
この記事は最終更新から3年以上経っています。情報が古くなっている可能性が高いです。
TypeScript には Promise や Symbol といった Javascript 特有のグローバルオブジェクト以外に、型を扱う上で便利になるような組み込みのジェネリックな型関数※1が存在します。これらは非常に便利で様々なプロジェクトで使われているので~すが、公式にリストもなく、説明も主にリリースノート等にしかないため、~使い方等を交えて説明を書いていきたいと思います。
なお、各定義はMicrosoft/TypeScript のsrc/lib/es5.d.tsにあります。
※1 ... 型を受け取って新しい型を返す型。多分正しい呼び名ではない。
type Partial<T>
型 T のすべてのプロパティを省略可能(つまり| undefined)にした新しい型を返す Mapped Type です。
interface Foo {
bar: number;
baz: boolean;
}
type PartialFoo = Partial<Foo>;
// PartialFoo {
// bar?: number
// baz?: boolean
// }
ライブラリのオプションの型を書く時なんかに非常に役立ちます。
interface Options {
host: string;
port: number;
}
const defaultOptions: Options = {
host: "localhost",
port: 3000,
};
const main = (options: Partial<Options> = {}) => {
const opts = { ...defaultOptions, ...options };
// ...
};
// 使う側
main({
port: 8080,
});
type Required<T>
型 T の全てのプロパティを必須にした新しい型を返します。
interface Foo {
bar?: number;
baz: boolean;
}
type RequiredFoo = Required<Foo>;
// RequiredFoo {
// bar: number
// baz: boolean
// }
type Readonly<T>
型 T の全てのプロパティにreadonly属性をつけた新しい型を返します。
interface Foo {
bar: number;
baz: boolean;
}
type ReadonlyFoo = Readonly<Foo>;
// ReadonlyFoo {
// readonly bar: number
// readonly baz: boolean
// }
type Pick<T, K extends keyof T>
型 T の中から K に当てはまるプロパティのみを抜き取った新しい型を返します。 なお、K には型 T に存在するキーを指定する必要があります。
interface Foo {
bar: number;
baz: boolean;
qux: string;
}
type BarAndQux = Pick<Foo, "bar" | "qux">;
// BarAndQux {
// bar: number
// qux: string
// }
react-redux 等の HoC を作成/使用する際に多用します。
type Omit<T, K extends keyof any>
型 T の中から、キー名が K に当てはまるプロパティを除外した新しい型を返します。 なお、Pick とは異なり K には T のキー名以外を指定することができます。
interface Foo {
foo: string;
bar: number;
baz: boolean;
}
type FooWithoutBar = Omit<Foo, "bar">;
// FooWithoutBar {
// foo: string
// baz: boolean
// }
type Record<K extends keyof any, T>
型 T なプロパティ K を持つレコード型を作成します。
interface Foo {
bar: number;
baz: boolean;
}
type StringFoo = Record<keyof Foo, string>;
// StringFoo {
// bar: string
// baz: string
// }
type Exclude<T, U>
型 T が型 U に代入可能であればnever、そうでなければ型 T を返す Conditional Type です。
主に Union Types から特定の型を取り除く際に使われます。
type A = Exclude<string, number>; // string
type B = Exclude<string, any>; // never
type C = Exclude<string | number | boolean, string | boolean>; // number
type Extract<T, U>
型 T が型 U に代入可能であれば型 T、そうでなければneverを返す Conditional Type です。
Exclude の逆ですね。
主に Union Types から特定の型を抽出する際に使われます。
type A = Extract<string, number>; // never
type B = Extract<string, any>; // string
type C = Extract<string | number | boolean, string | boolean>; // string | boolean
type NonNullable<T>
型 T からnullとundefinedを取り除いた型を返します。
type A = NonNullable<string | null>; // string
type B = NonNullable<null>; // never
type C = NonNullable<string>; // string
type Parameters<T extends (...args: any[]) => any>
関数型 T の引数の型をタプルとして抽出します。
function foo(arg1: string, arg2: number): void {}
function bar(): void {}
type Foo = Parameters<typeof foo>; // [string, number]
type Bar = Parameters<typeof bar>; // []
ちょくちょく使える場面はあるので覚えておくと便利です。
type ConstructorParameters<T extends new (...args: any[]) => any>
型 T のコンストラクタの引数の型をタプルとして抽出します。
Parametersのコンストラクタ版です。
class Foo {
constructor(arg1: string, arg2?: boolean) {}
}
type Bar = ConstructorParameters<typeof Foo>; // [string, boolean] | [string]
type ReturnType<T extends (...args: any[]) => any>
型 T の戻り値の型を返します。なお、T には関数型のみ指定可能です。
const foo = () => "foo";
type A = ReturnType<typeof foo>; // string
type B = ReturnType<typeof window.setTimeout>; // number
type C = ReturnType<() => void>; // void
type InstanceType<T extends new (...args:any[]) => any>
型 T のコンストラクタの返り値の型を返す型です。
class Foo {}
type A = InstanceType<typeof Foo>; // Foo
type B = InstanceType<any>; // any
type C = InstanceType<never>; // any
使いどころが全くわからない...。
type ThisType<T>
this の型を T とすることができる特殊な型です。型関数ではないですが便利なので一応記載します。
interface Foo {
bar: number;
}
interface Baz {
qux(): string;
}
const quux: ThisType<Foo> = {
myMethod() {
return this.bar;
},
};
const corge: Baz & ThisType<Foo> = {
qux() {
return this.bar.toString(16);
},
};
Javascript のライブラリを使う際にあると便利な型です。 詳細は Qiita に記事を上げてくれている人がいるので、それを参照してください。