Skip to content

Add a redeclare keyword to redeclare class attributes, behaving like override !: while keeping type modifiers.Β #63370

@denis-migdal

Description

@denis-migdal

πŸ” Search Terms

redeclare
declare override

Related issues:

βœ… Viability Checklist

⭐ Suggestion

A redeclare keyword behaving like override + declare while keeping previous type modifiers (e.g. readonly, protected, public).

type BaseType  = {};
type Overriden = {x: number};

class A {
      protected readonly foo: BaseType;

      constructor(protected readonly faa: BaseType) {}
}

class B extends A {
    redeclare foo: Overriden;
    // equivalent to "override [protected readonly] foo!: Overriden"

    constructor( redeclare faa: Overriden ) { super(faa); }
    // idem above. Do not set faa itself.
}

We could use redeclare with modifiers, e.g. public or -readonly to override previous type modifiers:

redeclare public faa: Overriden; // make it public, do not change whether it is readonly or not, etc.
redeclare public faa;       // make it public, do not change its type, whether it is readonly or not, etc.
redeclare -readonly faa; // make it read-write, do not change its type or its visibility.

I also suggest the related changes:

  • in constructor parameters, !: would mean "declare but do not set".
  • using declare as an alias to !: when used in constructor parameters, or with override.

Note: redeclare could also be used in other contexts, e.g. to precise a variable type (cf related issue), but this is not in the scope of this suggestion.

πŸ“ƒ Motivating Example

Currently, if you want to override an attribute, you have to:

type BaseType  = {};
type Overriden = {x: number};

class A {
      protected readonly foo: BaseType;
}

class B extends A {
    override readonly foo!: Overriden;
}

However, if you forget one of the type modifier (here: protected) you would have no warnings as it might be voluntary. A reader do not know if this is a mistake or not.

By using redeclare you would ensure no type modifier is forgotten, while making intents explicit.
Indeed, if the type modifiers are modified in class A, using redeclare ensures that all subclasses has the correct type modifiers (except if explicitly stated otherwise).

Also, redeclare would enable to redeclare a type from the constructor, instead of having to provide the type twice.

type BaseType  = {};
type Overriden = {x: number};

class A {
      protected readonly foo: BaseType;
}

class B extends A {
    constructor( redeclare foo: Overriden ) { ... }
}

πŸ’» Use Cases

  1. What do you want to use this for?

Safely re-declaring classes attributes.

  1. What shortcomings exist with current approaches?
  • We have to rewrite all type modifiers.
  • In constructors parameters, we would have useless (or even unwanted) attribute assignations.
  • Without constructors parameters, requires to provide the type twice.
  • With a generic base class, this is quite brittle : the base class and each of its subclasses needs to know which of the attribute might be redeclared. This could lead too an excessive amount of generic types if too much attributes.
  1. What workarounds are you using in the meantime?

I use constructors parameters with the useless assignations.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Awaiting More FeedbackThis means we'd like to hear from more people who would be helped by this featureSuggestionAn idea for TypeScript

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions