Typescript type that only allows keys whose fields are strings

Question

I have looked at similar questions, but they stop one step short of what I need. For example solution from this question doesn't work when I try to use it in a function: Playground

What I need is a function, which takes item T, and a key of T such that the compiler knows the key always refers to a string field, and so the return type of item[key] is string:

function f2<T> (item: T, key: StringOnlyKeys<T>): string {
    return item[key] as string;
}

This doesn't compile in the generic case, see playground link

General Grievance · Accepted Answer · 2022-10-24 17:01:48Z

1

This looks like it works:

function f2<T extends Record<any, any>>(item: T, key: StringOnlyKeys<T>): string {
    return item[key];
}

I'm not 100% sure why, but my guess is that TypeScript won't implicitly restrict generic type parameters. So, if you use an unrestricted <T>, that could be a number (for instance), and rather than saying "ah, well that means this function can't possibly be called with a number", instead the compiler says "I have no idea what StringOnlyKeys<number> means, so anything involving it must be any".

edited Oct 24, 2022 at 17:01

General Grievance

5,12039 gold badges39 silver badges60 bronze badges

answered Mar 3, 2022 at 10:34

user31601

2,6502 gold badges16 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Typescript type that only allows keys whose fields are strings

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related