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

Distinct type specification for public field members #54829

Open
5 tasks done
nicknotfun opened this issue Jun 29, 2023 · 3 comments
Open
5 tasks done

Distinct type specification for public field members #54829

nicknotfun opened this issue Jun 29, 2023 · 3 comments
Labels
Awaiting More Feedback This means we'd like to hear from more people who would be helped by this feature Suggestion An idea for TypeScript

Comments

@nicknotfun
Copy link

Suggestion

Right now for a field of a class we can use the modifiers public, protected & private to control visibility outside of the class, and also readonly to control whether reassignment is permitted. For encapsulation purposes it is nice to have a field that is publicly accessible however not necessarily modifiable, for example with #-prefix'd fields we can do:

class Holder {
  #holds = new Set<number>();
  
  get holds(): ReadonlySet<number> {
    return this.#holds;
  }
}

Within the class one can use this.#holds to get a Set, or externally this.holds to get ReadonlySet. It would be nice if the above in-fact had a shorthand that didn't require an accessor specification, e.g.

class Holder {
  public(ReadonlySet<number>) holds = new Set<number>();
}

Which is functionally identical to the above (including in terms of inferred typing). The definition would be that:

The public modifier, if with parenthesis-form, is permitted in addition to the private/protected modifiers (both optional) and specifies an alternative type to infer in a public context. If specified without other modifiers the field is presumed private.

🔍 Search Terms

private, modifier, public, access, readonly, fields, members

List of keywords you searched for before creating this issue. Write them down here so that others can find this suggestion more easily and help provide feedback.

✅ Viability 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, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

📃 Motivating Example

In order to detect bugs early narrow typing is often desirable to limit mutability of class fields, for example:

class ShardManager {
  held = new Set<number>();
  private lock = new DistributedLock();
 }
const shards = new ShardManger();

For brevity, ease of access, and succinct code, it is quite nice to be able to do shards.held in public code to get the list of currently held shards. However doing so also exposes risk, especially in libraries, as doing something simple like shards.held.add(5) could have unintended consequences by not respecting the assumptions the rest of the class makes (e.g. changes only occur under the lock).

To support this case we support a distinct type for public field access.

💻 Use Cases

Work-around:

class ShardManager {
  private myHeld = new Set<number>(); // Or #held
  private lock = new DistributedLock();
  get held(): ReadonlySet<number> {
    return this.myHeld;
  }
}

Is more lines of code, more verbose, and disconnects the access control from the field definition.

@MartinJohns
Copy link
Contributor

Duplicate of #37487.

@RyanCavanaugh RyanCavanaugh added Suggestion An idea for TypeScript Awaiting More Feedback This means we'd like to hear from more people who would be helped by this feature labels Jun 29, 2023
@RyanCavanaugh
Copy link
Member

I think these are actually different; this one is about class members having different types when read internally vs externally, whereas the other one is about the properties having different mutability modifiers

@MartinJohns
Copy link
Contributor

whereas the other one is about the properties having different mutability modifiers

It's discussed in the comments, and I'd say it's just a variation of how it's implemented. But then it's a duplicate of #51597, which was closed because of my comments. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Awaiting More Feedback This means we'd like to hear from more people who would be helped by this feature Suggestion An idea for TypeScript
Projects
None yet
Development

No branches or pull requests

3 participants