Generic typescript function to validate that the key of an object is a string

Question

Here is the function I'd like to write, and I cannot quite get the generic to work.

As you can see - I'd like to return that T[K] is definitely a string - the point is to be able to use it

a = {key: "unknown type"};

if (!validateRequiredStringKey(a, "key")) {
    return
}
// Here we should know that a.key is a string

funcThatTakesAString(a.key);

export const validateRequiredStringKey = <
  T,
  K extends keyof T & (string | number)
>(
  obj: T,
  key: K
): obj is T & { [K]: string } => {
  const v = obj[key];

  if (!(typeof v === "string")) {
    throw new ValidationError(`${key} is not a string`);
  }
  if (v === "") {
    throw new ValidationError(`${key} is empty`);
  }
  return true;
};

The errors from tsc are

src/domain/validations/utils.ts:12:17 - error TS1170: A computed property name in a type literal must refer to an expression whose type is a literal type or a 'unique symbol' type.

12 ): obj is T & { [K]: string } => {
                   ~~~

src/domain/validations/utils.ts:12:18 - error TS2693: 'K' only refers to a type, but is being used as a value here.

12 ): obj is T & { [K]: string } => {

The syntax is {[k in K]: string} for a mapped type, or you can write Record<K, string> for convenience. — kaya3
– kaya3, Commented Mar 30, 2022 at 12:07

Oblosys · Accepted Answer · 2022-03-30 12:10:25Z

3

I haven't thoroughly checked the definition of validateRequiredStringKey, but you can make it work by replacing { [K]: string } with {[Key in K]: string}, or just Record<K, string>.

TypeScript playground

answered Mar 30, 2022 at 12:10

Oblosys

15.2k3 gold badges33 silver badges41 bronze badges

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

Collectives™ on Stack Overflow

Generic typescript function to validate that the key of an object is a string

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related