microsoft / microsoft/TypeScript
Proposal: allow variance annotations on input positions
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
⭐ Suggestion
I would like the in and out type modifiers to be able to applied to a generic type when it is being instantiated.
This would function by expanding the type by eliminating fields that are in violation of the requested constraint.
This might be thought of as another form of anonymous type mapping.
For example the code that can currently be written as
interface BivariantSetLike {
size: number;
}
interface CovariantSetLike<out T> extends BivariantSetLike {
getAll: () => Iterable<T>;
}
interface ContravariantSetLike<in T> extends BivariantSetLike {
add: (key: T) => void;
}
interface SetLike<in out T>
extends CovariantSetLike<T>,
ContravariantSetLike<T>,
BivariantSetLike {
constrain: (key: T) => T | undefined
}
declare const dogs: SetLike<Dog>;
const animals: CovariantSetLike<Animal> = dogs;
const poodles: ContravariantSetLike<Poodle> = dogs;
const countable: BivariantSetLike = dogs;
Could instead be written as
interface SetLike<in out T> {
size: number;
getAll: () => Iterable<T>;
add: (key: T) => void;
constrain: (key: T) => T | undefined;
}
declare const dogs: SetLike<Dog>;
const animals: SetLike<-in Animal> = dogs;
const poodles: SetLike<-out Poodle> = dogs;
const countable: SetLike<-in -out void> = dogs;
I'm not opposed to allowing the non-negated forms to be used in type instantiations, but in line with the existing pattern that in and out already don't impose variance restrictions on otherwise variant code: I think the positive forms, if they are even syntactically allowed, should always no-op. So MyType<T> == MyType<in T> == MyType<out T> == MyType<in out T>
readonly and writeonly
field: -in T -> readonly field: T
field: -out T -> set field(value: T)
readonly field: -in T -> readonly field: T
readonly field: -out T -> (field is skipped)
set field(value: -in T) -> (field is skipped)
set field(value: -out T) -> set field(value: T)
This would break for an index signature type like {[n: number]: T} for -out T, because there is no syntax to describe a writeonly [n: number].
Perhaps, instead of simplifying types to remove the -in ReifiedT, it is just legal to use the -in and -out modifiers anywhere a type is legal inside of an object type, and it just impacts the semantics of the type.
If this were the case, it would be legal to write something like {x: -in number} as an alias for {readonly x: number}. I'm not particularly fond of this option, but it does provide an elegant answer for lacking writeonly.
Strict Methods
TypeScript treats methods and functions differently when it comes to variance (assuming --strictFunctionTypes, which is table stakes for any use of the in out modifiers anyway). I think the special treatment of methods should be ignored when using this new syntax, as it largely defeats the purpose. So WritableFunction and WritableMethod will remain distinct, but T1 and T2 ought to be be identical:
interface WritableFunction<T> {
write: (value: T) => void;
}
interface WritableMethod<T> {
write(value: T): void;
}
type T1 = WritableFunction<-in number>;
type T2 = WritableMethod<-in number>;
The alternative is to make a --strictMethodTypes flag that enables method type checking everywhere.
This proposal's syntax would, I believe, allow for things like Array to be mostly usable, despite their non-variance.
🔍 Search Terms
Variance covariance contravariance bivariance in out input
✅ Viability Checklist
- 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 isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
L'issue non indica alcun file di implementazione né alcun test. Inizia individuando i percorsi di controllo dei tipi e di istanziazione dei generics di TypeScript, quindi confrontali con gli esempi di variance, readonly/writeonly, index-signature e strict-method. Il lavoro è completato quando sono stati concordati i significati delle alternative e i test del compilatore coprono la sintassi proposta.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100