microsoft / microsoft/TypeScript
Proposal: The internal modifier for classes
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
The internal modifier
Often there is a need to share information on types within a program or package that should not be
accessed from outside of the program or package. While the public accessibility modifier allows
types to share information, is insufficient for this case as consumers of the package have access
to the information. While the private accessibility modifier prevents consumers of the package
from accessing information from the type, it is insufficient for this case as types within the
package also cannot access the information. To satisfy this case, we propose the addition of the
internal modifier to class members.
Goals
This proposal aims to describe the static semantics of the internal modifier as it applies to members of a class (methods, accessors, and properties).
Non-goals
This proposal does not cover any other use of the internal modifier on other declarations.
Static Semantics
Visibility
Within a non-declaration file, a class member marked internal is treated as if it had public
visibility for any property access:
source.ts:
class C {
internal x: number;
}
let c = new C();
c.x = 1; // ok
When consuming a class from a declaration file, a class member marked internal is treated as
if it had private visibility for any property access:
declaration.d.ts
class C {
internal x: number;
}
source.ts
/// <reference path="declaration.d.ts" />
let c = new C();
c.x = 1; // error
Assignability
When checking assignability of types within a non-declaration file, a class member marked
internal is treated as if it had public visibility:
source.ts:
class C {
internal x: number;
}
interface X {
x: number;
}
let x: X = new C(); // ok
If one of the types is imported or referenced from a declaration file, but the other is defined
inside of a non-declaration file, a class member marked internal is treated as if it had
private visibility:
declaration.d.ts
class C {
internal x: number;
}
source.ts
/// <reference path="declaration.d.ts" />
interface X {
}
let x: X = new C(); // error
It is important to allow assignability between super- and subclasses from a declaration file
with overridden members marked internal. When both types are imported or referenced from a
declaration file, a class member marked internal is treated as if it had protected visibility:
declaration.d.ts
class C {
internal x(): void;
}
class D extends C {
internal x(): void;
}
source.ts
/// <reference path="declaration.d.ts" />
let c: C = new D(); // ok
However, this does not carry over to subclasses that are defined in a non-declaration file:
declaration.d.ts
class C {
internal x(): void;
}
source.ts
/// <reference path="declaration.d.ts" />
class D extends C {
internal x(): void; // error
}
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza estudiando las secciones de semántica estática de la propuesta y sus ejemplos sobre la visibilidad y la asignabilidad de miembros en archivos de declaración y archivos que no son de declaración. Se considera terminado cuando el internal modifier se comporta de forma coherente con las reglas indicadas para public, private y protected, incluidos los miembros sobrescritos y el caso de la subclase en un archivo que no es de declaración.
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
- 25/100