-
Notifications
You must be signed in to change notification settings - Fork 12.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fleshing out type operators (discussion) #16392
Comments
There are several dead links: |
@ikatyang fixed them, thanks! |
Update: I fleshed out operations on number literals (if restricted to whitelisted natural numbers), and realized that, although we can't really manipulate tuple types without The implication here is that the vast majority of the remaining unresolved challenges now suddenly hinge on a single outstanding feature request (#6606). |
As Playground became less suitable as things grew, I now moved the types into a repo. |
Stellar work. I'm going to pour over this when I get home tonight. Maybe we should turn this into a test suite too and get it accepted into Typescript, so there's no regressions? |
@SimonMeskens: I'd certainly love to improve
tl;dr: hopefully, but things might not be mature enough yet. That said I did see two types failing I'd sworn worked before, specifically |
It feels like we should be able to do ReturnType right now. What's stopping us? |
@SimonMeskens: try it! interface MyFn {
(s: string): string;
(b: boolean): boolean;
}
// ^ example of a problematic function: overloads. similar for generics.
type Ret<F extends (...args: any[]) => R, R> = R;
type Bar = Ret<MyFn>;
// ^ error: Generic type 'Ret' requires 2 type argument(s).
declare function ret<R>(f: (...args: any[]) => R): R;
let baz = ret(null! as MyFn);
// ^ expression level, can't be composed into bigger types
// -> boolean. other option got ignored? In function declarations, we can do an easy version naively extracting a return type, see the snippet below; a type-level-only version fails meaning we can't really put this to use in other types. |
Ah yes, it's basically the issue I talked about on the dynamic function type issue. You can create such a function (well, once 2.5 lands to fix a few of the mapped type bugs), but I don't think TypeScript could ever support complex functions (generics, overloads, not sure about |
Could you show a snippet of how you'd go about it with that?
If you mean the awkward |
Not really, because I ran into several bugs trying to make it. The basic idea is that you specify arity by hand and the compiler will complain if the arity is incorrect. Unless we get some way to pattern match types, we can't make the compiler infer arity unfortunately. The arity can be somewhat inferred through a number of overloads at call-site. Once 2.5 lands, I'll try to produce this type. I'm somewhat skeptical of 6606, because if it would actually provide a fully working return type, it would be more powerful than Haskell's compiler, if I understand correctly, and I simply don't see how Typescript's generic system would give rise to such a construct. I just returned from a vacation, so my brain is currently too fried to provide an example, I'll try to do so later. |
If you want you can try 2.5 nightly outside of playground. Heck, even if the code doesn't work yet, the concepts would still be interesting anyway. We'd have progress even if just for arity 0 it works purely on the type level.
TypeScript has been doing type literal computations that Haskell never bothered with, e.g. property access on tuples / heterogeneous objects using number / string literals. Ditto for boolean literals, see the type guards in the tutorial. I'd asked a few Haskell friends this same question before, and their response was just kinda that it wouldn't have as much use for it, in the sense its tuples lacked number-based access, and that heterogeneous objects with string index access basically also lacked a Haskell equivalent. |
I see your point now, you want to be able to infer the return type, not just typecheck it. I don't think that's possible without something like #14400. Honestly, I feel like not having #14400 is holding the language back. That's probably my number one feature request, more inference on generic arguments. |
Well, #14400 itself wouldn't address overloads/generics or the like, while we can already get the return type like that in function definitions already ( |
#14400 Already exists in C# and many other, simpler languages. It's a small subset of what you want to cover with 6606. On the other hand, 14400 opens up a bunch of doors all over the place, not just for return types. |
Alright, fair enough.
…On Sat, Aug 5, 2017 at 10:11 PM, Simon Meskens ***@***.***> wrote:
#14400 <#14400> Already
exists in C# and many other, simpler languages. It's a small subset of what
you want to cover with 6606. On the other hand, 14400 opens up a bunch of
doors all over the place, not just for return types.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#16392 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AC6uxfISBevyZFa_qkKRGGfsiAC9G8Ngks5sVHf_gaJpZM4N1Jex>
.
|
I've just posted a suggestion for type declaration overloading at #17636. @tycho01, I wonder if you'd like to have a look and see how useful you think that might be to realising some of the stuff in this issue? I'll take more of a look myself when I have the time, but I'm pretty sure @17636 would open up |
@TheOtherSamP: Going by my list in 6606: overloading covers:
not covered is function application:
Going by my list here:
tl;dr:
Edit: one potential con of your type overloading approach is that it may require adding external types, while a function approach might also allow anonymous functions. From what I can see this should not necessarily be a deal-breaker for any of its use-cases though. |
@tycho01 That's great, thanks! That's a big list of stuff that works. Honestly, even when we get #6606 I still think it would be nice to have both. Type declaration overloads seem neater for these things, having to bring functions into those operations feels like a bit of a hack. I think I'd be in favour of having both features in the language alongside each other. Would you mind copying that list over to #17636? I think you've made a pretty decent argument in favour of it being worth considering there, far more exhaustive than mine, it would be nice to have it in that issue. Alternatively I could steal it and edit it into the main post I suppose. |
@TheOtherSamP: I found a few kinks:
Examples depending on this:
This could also be tackled through #14400.
There are anonymous functions, yet not (yet) anonymous types. As a result, a 6606-based approach allows type 'currying'. export interface isT<T> {
(v: T): '1';
(v: any): '0';
}
export type Matches<V, T> = isT<T>(V); With #17636 that might look a bit like:
The 6606 approach might allow terse derivatives e.g. tl;dr aside from doing stuff with actual functions, 17636 covers the use-cases of 6606 with a few (fixable) holes, namely capturing inferred types (#14400) and anonymous types (not aware of proposals). So yeah, I'll post there too. I think I should have the differences down now. |
I'm not sure if this is new, but I found a cool trick that allows some basic type switching (and more cool things) by augmenting some global interfaces. It's a bit hackish, but I think it's okay, I haven't hit any problems with it yet. It also allows the implementation of Figured it was worth noting here in case it's new and opens up anything else on this list. I don't know if there's a fancy way to link to gists, but here: https://gist.github.com/TheOtherSamP/ab0c7305d241cee4c7f0452f11a4d1f1 |
@TheOtherSamP: makes sense. In that case I guess your question on why the type-checker was cool with it sounds pretty legitimate. |
@tycho01 Yeah, there actually seems to be a larger issue (though it's useful so far, maybe feature?) with constraints not being checked properly in nested/recursive types. Although now I think about it, I wonder if something is becoming |
Although this toy example to recreate the issue actually does get caught, so whatever that behaviour is is a bit more subtle. type MustBeNumber<T extends number> = T;
type KeyofWhatever<T> = {[K in keyof T]: MustBeNumber<T[K]>}; // Errors I'll have to fiddle about and see if I can recreate. I think I also found another bug (something was working inline, but not through a layer of type declaration abstraction) earlier too, but I just went a completely different route around it, so I'll have to see if I can recreate that for bug report. |
@TheOtherSamP: this is one of the things I find tougher about type-level programming; you can't just like cram in some logging statement for debugging... I do wonder how people with more experience like @gcnew are going about that, assuming it doesn't require full familiarity with the compiler so as to run it through that with breakpoints. |
@tycho01 Yeah absolutely, there's a lot of trial-and-error involved in my process here, rapid iteration, and stuff like this sitting around for debug-by-tooltip checking: type H = DeepReadonlyObject<DummyInterface>;
// type A = HasProperty<{test: 5}, "test">;
type IsArrayTest = IsArray<Array<string>>;
type C<T> = IsArray<T>;
type D = SpecialTypeOf<string>;
type E = HasSpecialType<string[]>;
type F = IsSpecial<string, "array">;
type G = IsArray<string>;
type I = DeepReadonlyArrayUnsafe<string[]>; I also try to break the bits I'm working on down into as many smaller declarations as possible so I can get in there and test bits individually. Then of course there are those few times when breaking them up (buggily?) changes the result like I hit earlier with this... That's no fun. |
Oh, good find @SimonMeskens! It's hard to know if those are the exact issues I'm running into, but they're (the second particularly) definitely highlighting problems in the same area I'm dealing with, looks like a good fit. I'm a little worried that the recursive stuff in my |
I stuck my gist into the playground with a little test right at the bottom, if anyone wants to play with |
@TheOtherSamP: yeah, my gist got full of things like that until I recently turned them into 'tests' to publish as repo. |
@tycho01: Smart. Yeah, at this rate I'm having enough fun playing about that I might start putting together my own rival type library like yours. Not actually to compete, but it might be interesting to see if there are things we come up with different approaches to. I also have the sudden urge to try to leverage the compiler into integrating type based tests into existing testing tools... No idea if that's even possible, and it's probably insane, but it might be fun. I'll add it to my list. |
@TheOtherSamP: feel free to check how I'm doing the tests now, basically expressions asserting type outcomes that'll give compiler errors if they don't match (<=). So I 'run tests' just by compiling spec files. I just now ran that through |
@tycho01 That's way more sane that what I'm probably going to waste a load of time trying before finally admitting that your way was best all along. |
@TheOtherSamP @tycho01 I'm using |
@gcanti Oh wow, that looks fantastic, thanks for that link! Maybe not quite suited to the rapid iteration during prototyping, but great for marking things down once we've got them wrangled a bit. That was basically what I was going to try to make anyway, so that's saved me a lot of wasted time. 😅 |
@TheOtherSamP: I loved PlayGround as well, and regressions weren't much of an initial concern; I was just forced to convert it as eventually a few types snuck in that had terrible performance / did not terminate. Fair enough, that does look like a potential improvement in the face of expected errors. On actual failed expectations, I recall I had a fork of it ditching line numbers from output so diff logs wouldn't get noise from line number changes, might have use for that here too. Guess I specialize in libraries that error. I hated having to give every test line a name btw 😅, fortunately that's separate. Seems unlike me you're also using value level expressions in your tests. That's interesting to me; I'd kept it type-level only. I don't even have any real considerations there, just sorta happened. |
@tycho01 When you say
What do you mean by "ignored"? Note that |
@jcalz: sorry, lemme fix that, looks like I was mistaken there!
Could be, but for all I know I just messed up there somehow. :)
Hm.... before I thought that e.g. This did just helped me think of an implementation for |
Marking as closed since a discussion doesn't require moderator attention. |
@jcalz @MartinJohns here is fine to me. I guess if we had a So the more realistic approach seems to be to use a filtered map instead. My attempt has been among the following lines: type T = { a: 1, [k: string]: number };
type stripped = { [P in keyof T]: string extends P ? never : T[P] }; // want { a: 1 }, got { [x: string]: string } Not sure why it fails. :( |
Yeah that's about as far as I got too. |
@jcalz @MartinJohns in retrospect, guess it fails because it still relies on |
Looks like type IsUnionType<T, Y=true, N=false> =
[T] extends [infer U] ? U extends any ? [T] extends [U] ? N : Y : never : never This exposes some fun details of what the compiler considers a union: const literalsGetAbsorbed : IsUnionType<string | 'a'> = false;
const booleansGetDistributed: IsUnionType<boolean> = true;
const intersectionsOfUnionsAreReduced: IsUnionType<{a: 0} & ({b: 1} | {c: 2})> = true; |
@tycho01 Are you still looking for a way to strip indexes? I have a way to do it |
Actually, my way of doing it corresponds to your last attempt up above, which now seems to work, so you should be golden. |
Doesn't that still give you |
Yeah, totally my bad. I thought I had discovered some new trick, when I didn't. I figured out most of the issues people were having as I bashed my head against it for an hour yesterday. |
This is a discussion thread where I'd like to give a high-level overview of the type-level operations (as opposed to expression-level) that we can and can not yet do today.
This differs from the TS roadmap by identifying holes, while complementing the issues list by trying to show some of the bigger picture, the goal being to see what issues tie into which points, and how we could address them.
I'd like stimulate discussion on how we could fill the holes here; for all I know there are holes we can find solutions to with no changes to TS!
Below is my list of imaginable basic type operations. The reason I focus on these is that, with basic operators down, most more complicated use-cases could be addressed simply by combining these. Names are based on my implementations here.
Additions / corrections / related issues / comments welcome!
Operations:
Built-in operators:
|
: allow either of two types. also helps get the more lenient of two types, i.e.T | never
->T
. you'll encounter this in type inference since optional params yield| undefined
types. no known warts.&
: get the stricter of two types, i.e.T & never
->never
. shouldn't need this very often. also helps combine two objects. warts:&
their contents too (alt:Overwrite
/MergeAll
)keyof
: create a union of string literals from a type's keys. warts:in
: construct an object type based on a union of strings (keys) and corresponding calculated values based on these. warts:&
).toString
.&
is a bit less straight-forward from the rest in its use-cases:string & number
(uses?)never
(T & never
), which gets more useful given conditionals, but then you could just use those to conditionally producenever
right awayOverwrite
/MergeAll
(inferior in its behavior intersecting types in overlapping keys, which poorly reflects actual JS). if you know keys won't overlap though, it's great since it's short, built-in and performant.Matches
Boolean operations:
Not
,And
,Or
,Eq
,Neq
Note: these can currently be implemented through string literal representations. It would be possible to convert these to boolean literals (
StringToBool
), but cannot yet map boolean literals to these (BoolToString
) or other values for that matter.Array (tuple) operations
Unary:
TupleLength
: check the length of a given tuple type.ArrayProp
: get the element type for a homogeneous array type (similar for extracting generics from other parameterized types)Binary:
[x]TupleProp
: get the type at a certain index for a tuple/array type. justT[I]
.TupleHasIndex
: check whether a tuple type contains a given index.TupleHasElem
: check whether a tuple type contains a given type among its elements. This could be done givenTypesEq
.ArrayLike
), but could become possible for tuple types natively with the variadic kinds proposal at Proposal: Variadic Kinds -- Give specific types to variadic functions #5453.There has been talk there this would also depend on Proposal: strict and open-length tuple types #6229.Vector
: create a tuple type for a given element type plus size.Advanced:
TupleLength
reduce
: the function needsReturnType
for its dynamic reducer functions; otherwise doable using iteration. see Proposal: add a built-inreduce
function on the type level #12512.map
over tuples: doable now through numerical objects for fixed conditions; also needsReturnType
in case the mapping function is given as a function (e.g.map
itself).object operations
Unary:
ObjectLength
: check the length (number of keys) of a given heterogeneous object type. doable givenUnionLength
or (object iteration +Inc
).Binary:
ObjectProp
(need to test): get the type at a certain index for an object type. Normally one would just useT[K]
, which offers the desired behavior if one expects prototype methods liketoString
to prioritize the prototype over the string index. If one instead expects these to trigger the string index, you'd want this instead.ObjectHasStringIndex
: check whether an object has a generalstring
key, e.g.[k: string]: any
.ObjectHasNumberIndex
: accessing it works or throws, not sure how to check presence though.ObjectNumberKeys
: anumber
variant ofkeyof
. could be pulled off given union iteration (Partial
-> iterate to filter / cast back to number literals)... but still hard to scale past natural numbers.ObjectSymbolKeys
: aSymbol
variant ofkeyof
. no clue how to go about this unless by checking a whitelisted set such as those found in standard library prototype. this feels sorta useless though.ObjectHasKey
: check whether a heterogeneous object type (-> like{ a: any }
as opposed to{ [k: string]: any }
) contains a given key.ObjectHasElem
: check whether a heterogeneous object type contains a given type among its elements. This could be done givenTypesEq
.Overwrite
: merge objects, overwriting elements of the former by that of the latter. see #12215.Omit
(#12215): remove certain keys from a given object type.ObjectDifference
: remove all keys from an object that are part of a second object.IntersectionObjects
: filter an object to the keys also present in another object.FilterObject
: can be done already for fixed conditions; using a predicate function needsReturnType
Advanced:
map
over heterogeneous objects: probably just needsReturnType
.ObjectToArray
. This could enable union iteration, or the other way around.UnionToArray
) then using array iteration.Alternatively, break string literals into characters, convert to numbers, convert objects to a nested version with one key at each stage using key sort, which could then be traversed in order... Nope, no member access on string literals.Type operations
Type checks (binary):
Matches
: check whether a given type matches another type (inclusive, e.g. true forstring
andstring
). This could be done givenReturnType
.TypesEq
: check whether two types are 'equal', that is, A satisfies B and vice versa. This could be done givenMatches
.InstanceOf
: check whether a given type represents a subset of another type (-> exclusive match). This could be done givenMatches
.PrototypeOf
: get the prototype (-> methods) of a type.Partial
helps, thoughSymbol
-based keys get killed.Type casts (unary):
StringToBool
: can be implemented manually given the limited options, mapping desired keys totrue
/false
, potentially having anything else fall back toundefined
/boolean
. string literals are used in the boolean operators above, while boolean literals are useful in e.g. type guards (expression-level if/else).BoolToString
-- mapping from non-strings could be done givenReturnType
.StringToNumber
-- convert a numerical string literal to an actual number literal, doable using a whitelist (doesn't scale well to higher numbers).NumberToString
-- convert a number literal to a numerical string literal, doable using a whitelist (doesn't scale well to higher numbers).UnionToObject
-- use a union of string literals as object keys, possible with e.g.{ [P in Union]: P }
.UnionToArray
: could be done given e.g. union iteration.ObjectToArray
: could be useful if converting tuples types to number-indexed object types, do further operations, then convert back. likely needs object iteration.ObjectKeysToUnion
--keyof
does this.ObjectValsToUnion
: just plug the keys back into the objectTupleToObject
: convert a tuple type to an object type (both number/string indices work), cleaning out prototype methods.TupleToUnion
: convert a tuple type to a union of types.TupleIndicesToUnion
: get the indices of a tuple type as a union of numerical strings.Union operations
Unary:
"a" | "b" | "c"
to"a"
. this could enable union iteration usingDiff
if they're all string literals, which in turn could enable object iteration. or the other way around.IsUnionType
-- solvable today only for unions consisting of known sets of keys, see myIndeterminate
; a proper solution could be made using union iteration or a way to access arbitrary / random elements (e.g. with conversion to tuple type)UnionLength
: check the length of a union, i.e. how many options it is composed of.Binary:
A | B
UnionHasKey
: check whether a union of string literals contains a given key.UnionHasType
: general case, check whether a union of arbitrary types contains a given type.TypesEq
. plugging a union into it should return e.g."0" | "1"
in case it contains a match -- at that pointUnionHasKey
works.IntersectionUnions
: get the intersection of two union types, possible today given unions of string literals.DifferenceUnions
: subtract any keys from one union from those contained in another union.UnionContained
: verify whether one union is fully contained in another.Advanced:
UnionToArray
,IsUnionType
. could be achieved givenUnionToArray
or a way to access elements from a union. This could enable object iteration, or the other way around.intersection operationsfunction/parameter operations
ReturnType
: get the return type of function expressions -- Proposal: Get the type of any expression with typeof #6606 (dupes: Suggestion: Using typeof with an expression #4233, Type query for a result of a function call #6239, Get return type of interface function #16372)ReturnType
, apply a function with arguments that would not match its requested param typesReturnType
, use overloaded type-level function application to emulate pattern matching from other languages.0
. given pattern matching (above), just add an extra generic to said division function using a default with pattern matching to only resolve for non-0
input, e.g.function div<B extends number, NotZero = { (v: '1') => 'whatever'; }({ (v: 0) => '0'; (v: number) => '1'; }(B))>(a: number, b: B)
.operations on primitives (string/number/boolean literals)
These are currently considered out of scope, see #15645.
That said we can do a bit with natural numbers:
Inc
,Dec
,Add
,Subtract
,Mult
,Pow
,DivFloor
,Modulo
, comparators:Gt
(>
),Lt
(<
),Gte
(>=
),Lte
(<=
)Strings:
Progress:
*: union operators are pretty much limited to unions of string literals as it stands, as the only basic operators on unions (
in
+ member access) both operate exclusively on these.Not listed: type-level type checks (also need #6606)
Top features needed:
BoolToString
,map
over tuples / heterogeneous objects,FilterObject
,reduce
, function compositionchooseOverload
consider type parameter values, not just their constraints. needed for:ReturnType
,Matches
/TypesEq
/InstanceOf
,ObjectHasElem
,TupleHasElem
, throwing errors, pattern matching, constraints,ObjectHasNumberIndex
.[...a]
(tuple manipulation): can be emulated with numerical objects, but they lack methods.(...args: Args) =>
(capturing params)Fn(...Args)
- relevant for e.g. composition,curry
andbind
....
from union into tuple: casting union/object to tuple. note this one is tougher in that order is technically undefined. Challenges this would address includeUnionLength
,ObjectLength
,UnionHasType
,UnionToArray
,ObjectNumberKeys
, union member access, andObjectToArray
. this last one helps type e.g.R.toPairs
; the current compromise alternativeArray<a|b|c>
there is less useful since it can't be iterated over (for e.g.map
).const
/ params#16072 - generics erasedThe text was updated successfully, but these errors were encountered: