[Feature request]type level equal operator #27024

kgtkr · 2018-09-11T09:14:40Z

Search Terms

Type System
Equal

Suggestion

T1 == T2

Use Cases

TypeScript type system is highly functional.
Type level testing is required.
However, we can not easily check type equivalence.
I want a type-level equivalence operator there.

It is difficult for users to implement any when they enter.
I implemented it, but I felt it was difficult to judge the equivalence of types including any.

Examples

type A = number == string;// false
type B = 1 == 1;// true
type C = any == 1;// false
type D = 1 | 2 == 1;// false
type E = Head<[1,2,3]> == 1;// true(see:#24897)
type F = any == never;// false
type G = [any] == [number];// false
type H = {x:1}&{y:2} == {x:1,y:2}// true

function assertType<_T extends true>(){}

assertType<Head<[1,2,3]> == 1>();
assertType<Head<[1,2,3]> == 2>();// Type Error

Checklist

My suggestion meets these guidelines:

This wouldn't be a breaking change in existing TypeScript / JavaScript code
This wouldn't change the runtime behavior of existing JavaScript code
This could be implemented without emitting different JS based on the types of the expressions
This isn't a runtime feature (e.g. new expression-level syntax)

AlCalzone · 2018-09-11T10:34:33Z

Here's a working implementation:

/**
 * Tests if two types are equal
 */
export type Equals<T, S> =
	[T] extends [S] ? (
		[S] extends [T] ? true : false
	) : false
;

The only problem is that any is "equal to" everything, except never.

kgtkr · 2018-09-11T10:45:07Z

@AlCalzone
I know that.(https://github.com/kgtkr/typepark/blob/master/src/test.ts)
There is a problem of not being able to judge any.

example:

type X=Equals<{x:any},{x:number}>;//true

DanielRosenwasser · 2018-09-11T21:26:36Z

any is not assignable to never, so you should be able to determine whether or not either side is exclusively any.

mattmccutchen · 2018-09-15T04:23:39Z

Here's a solution that makes creative use of the assignability rule for conditional types, which requires that the types after extends be "identical" as that is defined by the checker:

export type Equals<X, Y> =
    (<T>() => T extends X ? 1 : 2) extends
    (<T>() => T extends Y ? 1 : 2) ? true : false;

This passes all the tests from the initial description that I was able to run except H, which fails because the definition of "identical" doesn't allow an intersection type to be identical to an object type with the same properties. (I wasn't able to run test E because I don't have the definition of Head.)

kgtkr · 2018-09-22T00:44:22Z

Thank you
There was a way

aleclarson · 2019-04-11T22:19:38Z

The best solution I have to date: spec.ts

Examples

jituanlin · 2019-07-09T06:17:34Z

Here's a solution that makes creative use of the assignability rule for conditional types, which requires that the types after extends be "identical" as that is defined by the checker:
export type Equals<X, Y> =
    (<T>() => T extends X ? 1 : 2) extends
    (<T>() => T extends Y ? 1 : 2) ? true : false;
This passes all the tests from the initial description that I was able to run except H, which fails because the definition of "identical" doesn't allow an intersection type to be identical to an object type with the same properties. (I wasn't able to run test E because I don't have the definition of Head.)

It work, but how?
Could you provide more explanation?
I try to explain it though by Typescript's bivariant behavior or something else.
But I failed, help, pls.

fatcerberus · 2019-07-12T15:13:50Z

@jituanlin AFAIK it relies on conditional types being deferred when T is not known. Assignability of deferred conditional types relies on an internal isTypeIdenticalTo check, which is only true for two conditional types if:

Both conditional types have the same constraint
The true and false branches of both conditions are the same type

weakish · 2019-12-22T05:26:51Z

@AlCalzone It seems that function overloads do not work.

type F = (x: 0, y: null) => void
type G = (x: number, y: string) => void

type EqEq<T, S> = [T] extends [S] ? ([S] extends [T] ? true : false) : false

// Function type intersection is defined as overloads in TypeScript.
type OF1 = EqEq<F & G, G & F> // true
type OF3 = EqEq<{ (x: 0, y: null): void; (x: number, y: null): void }, { (x: number, y: null): void; (x: 0, y: null): void }> // true

@mattmccutchen

Function overloads works:

type EqEqEq<X, Y> =
  (<T>() => T extends X ? 1 : 2) extends
  (<T>() => T extends Y ? 1 : 2) ? true : false;

type OF4 = EqEqEq<{ (x: 0, y: null): void; (x: number, y: null): void }, { (x: number, y: null): void; (x: 0, y: null): void }> // false

But function type intersection does not work:

type OF2 = EqEqEq<F & G, G & F> // true

AnyhowStep · 2020-03-10T07:21:51Z

Can we re-open this or something? Because there isn't a way =(

AnyhowStep · 2020-06-15T14:23:24Z

#37314 (comment)

Seems like it's fixed in master, with TS 4.0 as the milestone.

So, this doesn't need to be re-opened, I suppose. I forgot to link to that comment sooner, my bad.

ldqUndefined · 2020-09-09T02:52:31Z

@jituanlin AFAIK it relies on conditional types being deferred when T is not known. Assignability of deferred conditional types relies on an internal isTypeIdenticalTo check, which is only true for two conditional types if:

Both conditional types have the same constraint

The true and false branches of both conditions are the same type

where can I find the infomations about the internal 'isTypeIdenticalTo' check? I can't find anything in the typescript official website....

weakish · 2020-09-09T03:17:08Z

@ldqUndefined I do not remember it well, but you may find it in the source code (or not, since TypeScript source code changed a lot).

gogoyqj · 2021-02-13T14:01:02Z

Here's a solution that makes creative use of the assignability rule for conditional types, which requires that the types after extends be "identical" as that is defined by the checker:
export type Equals<X, Y> =
    (<T>() => T extends X ? 1 : 2) extends
    (<T>() => T extends Y ? 1 : 2) ? true : false;
This passes all the tests from the initial description that I was able to run except H, which fails because the definition of "identical" doesn't allow an intersection type to be identical to an object type with the same properties. (I wasn't able to run test E because I don't have the definition of Head.)

not work for:

type ExampleV51 = Equals<1 | number & {}, number>; // supposed to be true, but false got

wvanvugt-speedline · 2021-05-21T05:05:01Z

I devised a type which seems to work for all scenarios, including intersection types. While it lacks the elegance of the other solutions, it appears to perform better than either based on the tests.

type Equals<A, B> = _HalfEquals<A, B> extends true ? _HalfEquals<B, A> : false;

type _HalfEquals<A, B> = (
    A extends unknown
        ? (
              B extends unknown
                  ? A extends B
                      ? B extends A
                          ? keyof A extends keyof B
                              ? keyof B extends keyof A
                                  ? A extends object
                                      ? _DeepHalfEquals<A, B, keyof A> extends true
                                          ? 1
                                          : never
                                      : 1
                                  : never
                              : never
                          : never
                      : never
                  : unknown
          ) extends never
            ? 0
            : never
        : unknown
) extends never
    ? true
    : false;

type _DeepHalfEquals<A, B extends A, K extends keyof A> = (
    K extends unknown ? (Equals<A[K], B[K]> extends true ? never : 0) : unknown
) extends never
    ? true
    : false;

Here is a TypeScript Playground link demonstrating the functionality on all the test cases. If anyone knows how to optimize this code without sacrificing functionality, I'd love to hear.

JomoPipi · 2021-05-23T02:07:17Z

@wvanvugt-speedline
Nice, but it fails with this:

assertNotType<Equals<[any, number], [number, any]>>();

Here's mine (also fails there):

type And<X,Y> = X extends true ? Y extends true ? true : false : false
type IsAny<T> = 0 extends (1 & T) ? true : false

type _Equals<X,Y> = (X extends Y ? 1 : 2) extends (Y extends X ? 1 : 3) ? true : false
type _EqualTuple<X,Y,Z> = X extends [any] ? Y extends [any] ? Equals<X[number], Y[number]> : false : Z
type Equals<X,Y> = _EqualTuple<X,Y, And<_Equals<IsAny<X>, IsAny<Y>>, _Equals<X,Y>>>

playground

tianzhich · 2021-06-03T07:22:25Z

@jituanlin AFAIK it relies on conditional types being deferred when T is not known. Assignability of deferred conditional types relies on an internal isTypeIdenticalTo check, which is only true for two conditional types if:

Both conditional types have the same constraint

The true and false branches of both conditions are the same type

where can I find the infomations about the internal 'isTypeIdenticalTo' check? I can't find anything in the typescript official website....

I found this in /node_modules/typescript/lib/typescript.js, by searching isTypeIdenticalTo. There are also some comments that may help someone here:

// Two conditional types 'T1 extends U1 ? X1 : Y1' and 'T2 extends U2 ? X2 : Y2' are related if
// one of T1 and T2 is related to the other, U1 and U2 are identical types, X1 is related to X2,
// and Y1 is related to Y2.

But I'm still not very clear what the related mean here? I can't understand the src code of isRelatedTo.

tianzhich · 2021-06-03T08:02:17Z

I write some simple tests, seems A related to B means type A can extend from type B.

type Foo<X> = <T>() => T extends X ? 1 : 2

type Bar<Y> = <T>() => T extends Y ? number : number

type Related = Foo<number> extends Bar<number> ? true : false // true

type UnRelated = Bar<number> extends Foo<number> ? true : false // false

`Equals` and `assertType` are inspired by, respectively, microsoft/TypeScript#27024 (comment) and microsoft/TypeScript#27024. We carry on using standard ReactFlow edges and handles, for now. Though we may do something similar there eventually. EDIT: actually, we now define `PrimerEdge` for sort of forwards-compatibility This also puts us in slightly better shape to ditch ReactFlow for an alternative, should we want to, since we now implement better abstractions in some cases ourselves, using ReactFlow's API less extensively thoughout the codebase

As described in source comments, this is similar to ReactFlow's `Node`, but more type-safe. We are able to statically assert that the `data` fields of our nodes match what we tell ReactFlow to expect. `Equals` and `assertType` are inspired by, respectively, microsoft/TypeScript#27024 (comment) and microsoft/TypeScript#27024. We carry on using standard ReactFlow edges and handles, for now. Though we will likely do something similar there in future, once we require further customization. In fact, we now define a very simple `PrimerEdge` type for a small degree of forwards-compatibility. This also puts us in slightly better shape to ditch ReactFlow for an alternative, should we wish to, since we now implement better abstractions in some ways ourselves, using ReactFlow's types less extensively.

`boolean` is effectively the union type `true | false` but the current `isMatch` implementation will treat overlapping union types as matching. This patch introduces a more strict type equivalence check based on microsoft/TypeScript#27024 (comment) and uses it when checking types that extend `boolean` for equivalence to `boolean`. The test added in this patch fails without the corresponding code changes here. Fixes #754.

gfx · 2023-04-07T04:41:19Z

The "type-level equality operator" should be incorporated as a standard type function in TypeScript, as it constitutes a fundamental aspect of type computations.

Numerous valuable suggestions have been made in the comments, particularly "Matt's Equals<X, Y>," which works effectively in most cases, though it is not flawless. While some alternatives may outperform Matt's implementation, they tend to be overly complex. Therefore, I advocate for integrating this functionality directly into the TypeScript compiler.

unional · 2023-04-07T07:35:36Z

Hi, I mentioned in another thread, but not in this one.
That the type-plus Equal<A,B> works in every single cases that I know of, from my tests and the discussions in these thread.

Feel free to check it out:
https://github.com/unional/type-plus/tree/main/ts/equal

@ts-expect-error

…xclusively (#21) Fixes #29 Fixes #26 Fixes #5 > Note: I extracted a very small part of this PR to #20 This is a breaking change as I opted to remove the types that were no longer needed. They are exported though so it's likely some people depend on them. I can add these back as desired. This took a lot of tinkering. This topic and this equality check is discussed extensively at microsoft/TypeScript#27024 The main three edge-cases this implementation worked around are: 1. Explicitly handling `any` separately 2. Supporting identity unions 3. Supporting identity intersections The only remaining known issue with this implementation is: ```ts // @ts-expect-error This is the bug. expectTypeOf<{foo: number} & {bar: string}>().toEqualTypeOf<{foo: number; bar: string}>() ``` @shicks and I could not find a tweak to the `Equality` check to make this work. Instead, I added a workaround in the shape of a new `.simplified` modifier that works similar to `.not`: ```ts // The workaround is the new optional .simplified modifier. expectTypeOf<{foo: number} & {bar: string}>().simplified.toEqualTypeOf<{foo: number; bar: string}>() ``` I'm not entirely sure what to do with documenting `.simplified` because it's something you should never use unless you need it. The simplify operation tends to lose information about the types being tested (e.g., functions become `{}` and classes lose their constructors). I'll definitely update this PR to reference the `.simplified` modifier but I wanted to get a review on this approach first. One option would be to keep around all the `DeepBrand` stuff and to have `.deepBranded` or something being the modifier instead. That would have the benefit of preserving all the exported types making this less of a breaking change. --------- Co-authored-by: Misha Kaletsky <[email protected]> Co-authored-by: Misha Kaletsky <[email protected]>

Mario-Marion · 2023-05-23T09:06:10Z

I write some simple tests, seems A related to B means type A can extend from type B.

type Foo<X> = <T>() => T extends X ? 1 : 2

type Bar<Y> = <T>() => T extends Y ? number : number

type Related = Foo<number> extends Bar<number> ? true : false // true

type UnRelated = Bar<number> extends Foo<number> ? true : false // false

x1 and x2, y1 and y2 must keep the identical types, otherwise the following problems will occur:

type Foo<X> = <T>() => T extends X ? 1 : 2

type Bar<Y> = <T>() => T extends Y ? number : number

type Related = Foo<string> extends Bar<boolean> ? true : false // true

unional · 2023-05-23T17:23:04Z

x1 and x2, y1 and y2 must keep the identical types, otherwise the following problems will occur

@Mario-Marion feel free to check out or use the implementation in type-plus. It's working correctly in those cases.
If you want to have a different implementation, that's ok too, look forward to see a different approach and see if there are any cases can be uncoverered.

useSyncRef with two boolean needed a transform. Updated Equal type to properly compare boolean See: microsoft/TypeScript#27024 (comment)

craigphicks · 2023-12-12T20:30:54Z

Equals<string[]&number[], never[]>; // false
Equals<(string[]&number[])[0], never[][0]>; // true

craigphicks · 2023-12-12T21:20:07Z

@jituanlin AFAIK it relies on conditional types being deferred when T is not known. Assignability of deferred conditional types relies on an internal isTypeIdenticalTo check, which is only true for two conditional types if:
* Both conditional types have the same constraint

* The true and false branches of both conditions are the same type

It seems like saying

sameConstraintIn =  (set of all t s.t. extends X) === (set of all t s.t. extends Y)  
sameConstraintOut =  (set of all t s.t. notExtends X) === (set of all t s.t. notExtends Y)  
is equal = sameConstaintIn && sameConstraintOut

but in set theory that is the same as

X extends Y => for all x in X, x is in Y
Y extends X => for all y in Y, y is in X
isequal = X extends Y && Y extends X

The reason they are different lies in the implementation details only.

I suppose some time saving shortcuts taken with X extends Y && X extends Y are not taken with the more complicated version of equality. But there is no clue in the more complicated form as to what those shortcuts are.

Of course the more complicated version looks as unintelligible as Latin, so Geeks fluent in Latin love it.

RyanCavanaugh added the Question An issue which isn't directly actionable in code label Sep 21, 2018

kgtkr closed this as completed Sep 22, 2018

mattmccutchen mentioned this issue Nov 27, 2018

react: Improve type checking of component static properties. DefinitelyTyped/DefinitelyTyped#30730

Merged

9 tasks

AnyhowStep mentioned this issue Mar 10, 2020

Nested conditional types and generics, testing type equality evaluating to incorrect branch #37314

Closed

Means88 mentioned this issue Sep 6, 2020

Definition of Equal? type-challenges/type-challenges#153

Closed

antfu mentioned this issue Sep 17, 2020

How does Equal type works? type-challenges/type-challenges#225

Closed

Mr-haili mentioned this issue Nov 13, 2020

找点乐子 Check List Mr-haili/aaa-blog#58

Open

9 tasks

rajmondx mentioned this issue May 30, 2021

NewableFunction not working as intended #44337

Closed

tianzhich mentioned this issue Jun 3, 2021

TS 一些有趣的增强类型 tianzhich/dev-notes#6

Open

This was referenced Jul 31, 2021

Add Includes type sindresorhus/type-fest#217

Merged

Add ExactMatch type sindresorhus/type-fest#237

Closed

Hiroshiba mentioned this issue Aug 17, 2021

#101 バージョン0.4.0未満のプロジェクトファイルへの対応 VOICEVOX/voicevox#102

Merged

se030 mentioned this issue Feb 16, 2023

898 - Includes type-challenges/type-challenges#23639

Open

DetachHead mentioned this issue Feb 18, 2023

readonly and mutable types are incorrectly considered equal geoffreytools/ts-spec#3

Closed

tommy-mitchell mentioned this issue Mar 2, 2023

IsEqual identity issues sindresorhus/type-fest#537

Open

canalun mentioned this issue Mar 4, 2023

neverが絡んだ型推論についての質問です yytypescript/book#627

Closed

DragonnZhang mentioned this issue Apr 2, 2023

898 - Includes type-challenges/type-challenges#1568

Open

jkomyno mentioned this issue Jul 20, 2023

fix(client): types for mixed input type selections prisma/prisma#20180

Merged

millsp mentioned this issue Jul 25, 2023

fix(client): types oom and inferred length errors prisma/prisma#20161

Merged

fatcerberus mentioned this issue Jul 28, 2023

Design Meeting Notes, 7/28/2023 #55188

Closed

pkc918 mentioned this issue Aug 11, 2023

#00898 include pkc918/ts-challenges#11

Open

s-montigny-desautels mentioned this issue Nov 15, 2023

fix(syncRef): syncRef typing issue for boolean vueuse/vueuse#3553

Merged

5 tasks

miguel-leon mentioned this issue Dec 5, 2023

Generic type changes depending if its parameter type is wrapped or not. #56675

Open

FeelyChau mentioned this issue Dec 6, 2023

feat: add type check for compatible M-CreativeLab/jsar-dom#4

Merged

reverofevil mentioned this issue Dec 7, 2023

Get rid of tsd peggyjs/peggy#436

Merged

jcalz mentioned this issue Dec 11, 2023

Problem with function types, <T>() => T extends X ? () : () #56721

Open

trevorade mentioned this issue Mar 20, 2024

Run tsc on all test files sindresorhus/type-fest#837

Closed

hchlq mentioned this issue Apr 19, 2024

898 - Includes type-challenges/type-challenges#32969

Open

jacobamills mentioned this issue Sep 26, 2024

Type 'null' is not assignable to type 'T extends T ? null : Omit<T, keyof T>' #60076

Closed

iamkanguk97 mentioned this issue Oct 21, 2024

Difference between the Equal Type implemented in the Type Challenge Repository and the Equal Type in this issue. type-challenges/type-challenges#34874

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature request]type level equal operator #27024

[Feature request]type level equal operator #27024

kgtkr commented Sep 11, 2018 •

edited

Loading

AlCalzone commented Sep 11, 2018

kgtkr commented Sep 11, 2018 •

edited

Loading

DanielRosenwasser commented Sep 11, 2018

mattmccutchen commented Sep 15, 2018

kgtkr commented Sep 22, 2018

aleclarson commented Apr 11, 2019 •

edited

Loading

jituanlin commented Jul 9, 2019

fatcerberus commented Jul 12, 2019

weakish commented Dec 22, 2019 •

edited

Loading

AnyhowStep commented Mar 10, 2020

AnyhowStep commented Jun 15, 2020 •

edited

Loading

ldqUndefined commented Sep 9, 2020

weakish commented Sep 9, 2020

gogoyqj commented Feb 13, 2021

wvanvugt-speedline commented May 21, 2021 •

edited

Loading

JomoPipi commented May 23, 2021 •

edited

Loading

tianzhich commented Jun 3, 2021 •

edited

Loading

tianzhich commented Jun 3, 2021

gfx commented Apr 7, 2023 •

edited

Loading

unional commented Apr 7, 2023

Mario-Marion commented May 23, 2023

unional commented May 23, 2023

craigphicks commented Dec 12, 2023

craigphicks commented Dec 12, 2023 •

edited

Loading

[Feature request]type level equal operator #27024

[Feature request]type level equal operator #27024

Comments

kgtkr commented Sep 11, 2018 • edited Loading

Search Terms

Suggestion

Use Cases

Examples

Checklist

AlCalzone commented Sep 11, 2018

kgtkr commented Sep 11, 2018 • edited Loading

DanielRosenwasser commented Sep 11, 2018

mattmccutchen commented Sep 15, 2018

kgtkr commented Sep 22, 2018

aleclarson commented Apr 11, 2019 • edited Loading

jituanlin commented Jul 9, 2019

fatcerberus commented Jul 12, 2019

weakish commented Dec 22, 2019 • edited Loading

AnyhowStep commented Mar 10, 2020

AnyhowStep commented Jun 15, 2020 • edited Loading

ldqUndefined commented Sep 9, 2020

weakish commented Sep 9, 2020

gogoyqj commented Feb 13, 2021

wvanvugt-speedline commented May 21, 2021 • edited Loading

JomoPipi commented May 23, 2021 • edited Loading

tianzhich commented Jun 3, 2021 • edited Loading

tianzhich commented Jun 3, 2021

gfx commented Apr 7, 2023 • edited Loading

unional commented Apr 7, 2023

Mario-Marion commented May 23, 2023

unional commented May 23, 2023

craigphicks commented Dec 12, 2023

craigphicks commented Dec 12, 2023 • edited Loading

kgtkr commented Sep 11, 2018 •

edited

Loading

kgtkr commented Sep 11, 2018 •

edited

Loading

aleclarson commented Apr 11, 2019 •

edited

Loading

weakish commented Dec 22, 2019 •

edited

Loading

AnyhowStep commented Jun 15, 2020 •

edited

Loading

wvanvugt-speedline commented May 21, 2021 •

edited

Loading

JomoPipi commented May 23, 2021 •

edited

Loading

tianzhich commented Jun 3, 2021 •

edited

Loading

gfx commented Apr 7, 2023 •

edited

Loading

craigphicks commented Dec 12, 2023 •

edited

Loading