microsoft / microsoft/TypeScript

Suggestion: shorthand for templated type to extend and default to the same type

Open
#30,919 9 comments 13 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

default extends equals generics = template types is

Suggestion

Can we have a way to declare that a templated (generic) type both extends and is = a type value without repeating the type value?

declare function example<T extends Base = Base>(value: T): T;

A clean way to do this would be to allow the is keyword following a generic type:

declare function example<T is Base>(value: T): T;

Failing that, how about omitting the first type value?

declare function example<T extends = Base>(value: T): T;

Use Cases

Generic parameters with extended and default values set to the same are a reasonable pattern:

declare function querySelector<E extends Element = Element>(selectors: string): E | null;

In larger type definitions with many generics, these extends+= definitions can get a little cumbersome:

type BitAddThree<
    A extends Bit = Bit,
    B extends Bit = Bit,
    C extends Bit = Bit
> =
    [A, B, C] extends [0, 0, 0] ? [0, 0] :
    // etc. etc.
    [Bit, Bit, Bit];

Examples

declare function querySelector<E is Element>(selectors: string): E | null;
declare function querySelector<E extends = Element>(selectors: string): E | null;
type BitAddThree<A is Bit, B is Bit, C is Bit> = // ...
type BitAddThree<A extends = Bit, B extends = Bit, C extends = Bit> = // ...

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. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the proposed generic declaration examples and compare the is and extends = alternatives, then trace how the TypeScript type checker handles generic constraints and defaults. Done requires a settled syntax and semantics for equivalent constraint/default declarations, with the proposal's examples covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.