Skip to content
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

satisfies operator could not completely overshadow the existing contextual type #57667

Open
6 tasks done
Andarist opened this issue Mar 6, 2024 · 6 comments
Open
6 tasks done
Labels
Needs Proposal This issue needs a plan that clarifies the finer details of how it could be implemented. Suggestion An idea for TypeScript

Comments

@Andarist
Copy link
Contributor

Andarist commented Mar 6, 2024

๐Ÿ” Search Terms

satisfies contextual type implicit any parameters

โœ… Viability Checklist

โญ Suggestion

It would be great if satisfies wouldn't completely disassociate the expression from the existing contextual type.

๐Ÿ“ƒ Motivating Example

declare function fn<T extends Record<string, (arg: number) => void>>(
  obj: T,
): void;

// this works without problems
fn({
  foo: (a) => {},
  bar: (a) => {},
});

// but we can't add extra constraints through `satisfies` without breaking existing contextual  typing
fn({
  foo: (a) => {}, // Parameter 'a' implicitly has an 'any' type.(7006)
  bar: (a) => {}, // Parameter 'a' implicitly has an 'any' type.(7006)
} satisfies Record<"foo" | "bar", unknown>);

๐Ÿ’ป Use Cases

  1. What do you want to use this for?

It would be nice, at times, to add some extra constraints in places where the existing contextual type exists

  1. What shortcomings exist with current approaches?

satisfies breaks existing contextual typing so things like contextual parameters "break". It requires us to type the parameters manually or to introduce identity functions with those extra constraints like below

  1. What workarounds are you using in the meantime?

This is one of the possible workarounds:

declare function fn<T extends Record<string, (arg: number) => void>>(
  obj: T,
): void;

declare function identityConstraint<T extends Record<"foo" | "bar", unknown>>(
  arg: T,
): T;

fn(
  identityConstraint({
    foo: (a) => {},
    bar: (a) => {},
  }),
);

However, this has an unintended side-effect: excess property check doesn't apply to this object now.


A similar shortcoming related to ThisType and satisfies combination has been recently reported here.

@fatcerberus
Copy link

Doesn't this require a formal mechanism for "merging" arbitrary types? Any expression can be contextually typed by anything...

@RyanCavanaugh RyanCavanaugh added Suggestion An idea for TypeScript Needs Proposal This issue needs a plan that clarifies the finer details of how it could be implemented. labels Mar 6, 2024
@RyanCavanaugh
Copy link
Member

Doesn't this require a formal mechanism for "merging" arbitrary types

Yep, which is why we didn't do this initially. Given

const x: T = e satisfies U;

we need something that merges T and U.

Intersection was proposed as a mechanism here but was found to be insufficient; see #47920 (comment)

@Andarist
Copy link
Contributor Author

Andarist commented Mar 6, 2024

It's nice to see your comment, I couldn't find any comment that would mention this but your comment is very on point ๐Ÿ‘

@fatcerberus
Copy link

fatcerberus commented Mar 6, 2024

Oh crap @Andarist got replaced with an AI ๐ŸšŽ (it reminds me of those spam comments on blogs that are just awkwardly worded variants of โ€œgood job on this article, very informativeโ€ etc. with an url at the bottom thatโ€™s the actual payload)

@Andarist
Copy link
Contributor Author

Andarist commented Mar 6, 2024

As an AI language model I try to show respect where respect is due

@RyanCavanaugh
Copy link
Member

Frankly a low moment on this repo for neither @fatcerberus nor @Andarist to immediately recall a comment buried 48 comments deep in a "Read More..." on a closed issue from 2 years ago

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Proposal This issue needs a plan that clarifies the finer details of how it could be implemented. Suggestion An idea for TypeScript
Projects
None yet
Development

No branches or pull requests

3 participants