microsoft / microsoft/TypeScript
Suggestion: Allow local types to be declared in interfaces
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
I have something like this:
export interface Reducer<State, Types extends Action<string, any>> {
add<TypeName extends string, Payload>(action: {
type: TypeName,
reduce: (state: State, action: Payload) => State
}): Reducer<State, Types | Action<TypeName, Payload>>;
readonly cursorType: Cursor<State, Types>;
}
The details aren't that important except to illustrate that a Reducer is immutable, and has an add method that returns another Reducer, but see that the return type has something extra "unioned" into it. By repeated chained calls to add I can build up a big nasty old type that would be ugly to have fully declare by hand. Fortunately type inference takes care of building the type for me, which is great.
Then elsewhere in my code I want to be able to declare something called a "cursor", which needs to have a type that corresponds to the reducer's type. The cursor could be a field in a class so I need to be able to refer to the type so I can declare such a field.
So I want to provide a simple way to declare a const of the type "correct kind of cursor for a given reducer", leveraging the work that the TS compiler already did for me with its type inference.
My slightly hacky approach, as shown above, is to declare a readonly field cursorType. The value of this is at runtime is junk and should not be used! So I need a "here be dragons" comment on it. Its only purpose is to be prefixed with typeof, e.g.:
const R = getReducerSomehow();
class Test {
constructor(public readonly myCursor: typeof R.cursorType) { }
}
To fill in the cursorType field of a Reducer I have to do this filth:
newReducer.cursorType = {} as Cursor<State, Types>;
So cursorType really should never be used as a value. It doesn't even need to exist as a value. It will cause a runtime error if anyone tries to used it as a cursor. Ugh. But how else can I make this elaborately computed type available conveniently?
I'm wondering if TS could allow:
export interface Reducer<State, Types extends Action<string, any>> {
add<TypeName extends string, Payload>(action: {
type: TypeName,
reduce: (state: State, action: Payload) => State
}): Reducer<State, Types | Action<TypeName, Payload>>;
// not currently possible:
type CursorType = Cursor<State, Types>;
}
i.e. a type alias can be added to an interface. So now my implementation of Reducer no longer has to do anything. No nasty dummy runtime variable hack required.
And my usage example becomes:
const R = getReducerSomehow();
class Test {
constructor(public readonly myCursor: R.CursorType) { }
}
That is, CursorType is a type that can be referred to as if it was a member of an instance. Similar I guess to:
namespace N {
export type S = string;
}
const s: N.S = "hi";
In which N is an object at runtime and yet can also be used to find the type S.
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
Parti dagli esempi di Reducer, Cursor e del proposto CursorType presenti nell’issue, quindi analizza come TypeScript rappresenta i membri delle interfacce e gli alias di tipo. Determina gli entry point del compilatore e i test necessari per gli alias di tipo qualificati dall’istanza; il lavoro è completato quando la sintassi proposta supera il controllo dei tipi senza un campo a runtime, preservando il comportamento esistente delle interfacce.
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