Can we create an array of strings from a type/interface keys?

Question

Suppose there's type or interface named NumberLookupCriteria:

type NumberLookupCriteria = {
  dialCode: string;
  phoneNumber: string;
}

or

interface NumberLookupCriteria {
  dialCode: string;
  phoneNumber: string;
}

Can we somehow manage to get all the keys as an JS array of strings like this:

const keys = ['dialCode','phoneNumber']

Any idea?

ZecKa · Accepted Answer · 2022-03-02 08:02:17Z

1

No you can't because types and interfaces doesn't exists at runtime.

A workaround can be the use of class

View ts playground

class NumberLookupCriteria {
    constructor(
        readonly dialCode: string ="",
        readonly phoneNumber: string ="",
    ) {}
}

const arrayKey = (Object.keys(new NumberLookupCriteria()))

console.log(arrayKey) // ["dialCode", "phoneNumber"]

const test: NumberLookupCriteria = {
  dialCode: "a",
  phoneNumber: "b"
} 
// OK

const test: NumberLookupCriteria = {
  dialCode: "a"
} 
// KO: Property 'phoneNumber' is missing in type '{ dialCode: string; }' but required in type 'NumberLookupCriteria'

There is many post about it:

Get keys of a Typescript interface as array of strings
Get Type keys in TypeScript

answered Mar 2, 2022 at 8:02

ZecKa

3,0074 gold badges30 silver badges48 bronze badges

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

Collectives™ on Stack Overflow

Can we create an array of strings from a type/interface keys?

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