microsoft / microsoft/TypeScript

Distinct type specification for public field members

Abierto
#54,829 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

El issue no nombra archivos, pruebas ni puntos de entrada. Empieza revisando el parenthesized public modifier propuesto y su interacción con private, protected, readonly y los tipos de campo inferidos; para darlo por terminado se requerirían un diseño establecido y el comportamiento correspondiente de comprobación de tipos.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
typescript
Área
compilers
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.