Suggestion: Allow local types to be declared in interfaces
See original GitHub issueI 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
.
Issue Analytics
- State:
- Created 7 years ago
- Reactions:11
- Comments:12 (3 by maintainers)
Top GitHub Comments
Edit: Fixed an inconsistency.
Just thought of a few libraries that could really use them: React and friends. It’d be much easier to type, say, “components that resolve to a particular element”, using a local generic within a generic while still remaining humanly readable. Something like this:
The declaration files would grow a bit, but the user wouldn’t see most of the verification boilerplate.
May I note that allowing inner types to be both overridden and abstract solve the higher kinded type issue entirely? It does not create Turing-completeness, though, and makes it roughly on par with OCaml’s module types and inner types.