typesafe-ts API Documentation - v1.7.0
    Preparing search index...

    Type Alias Extends<SubType, SuperType>

    Extends: SubType extends SuperType ? true : false

    Utility type to check if one type extends another (subtype relationship). Equivalent to SubType extends SuperType ? true : false.

    Type Parameters

    • SubType

      The potentially narrower type

    • SuperType

      The potentially broader type

    true if SubType extends SuperType, false otherwise

    type Test1 = Extends<string, any>;              // true
    type Test2 = Extends<"hello", string>; // true (literal extends base)
    type Test3 = Extends<string, number>; // false
    type Test4 = Extends<never, string>; // true (never extends everything)
    type Test5 = Extends<{a: 1, b: 2}, {a: 1}>; // true (subtype extends supertype)