Defining object type without knowing properties keys in TypeScript

Question

I want to define an object type in TypeScript, that is composed of several properties of which I want to define the type, but without knowing them keys.

I could have used an array to filter, but I prefer to use properties to gain speed (my use case is a graph).

Ex:

{
    "edges": {
        "bc73c36e-db11-4020-bef9-9ba5ffe2d6d4": {
            "name": "John"
        },
        "0691e3c2-7c69-4ec8-8e59-6b0055855a38": {
            "name": "Mike"
        },
        "6f0ca8f0-d595-4cc2-a62f-adfe35ba4808": {
            "name": "Lucy"
        },
        ...
    }
}

How can I define this object type of edges in TypeScript?

V Maharajh · Accepted Answer · 2021-05-13 17:30:07Z

5

You're looking for Typescript's Index Signature.

type Edge = {
  name: string;
}

type Graph = {
  edges: { [key: string]: Edge };
}

answered May 13, 2021 at 17:30

V Maharajh

9,7795 gold badges34 silver badges35 bronze badges

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

Comments

Penny Liu · Accepted Answer · 2024-01-09 09:17:04Z

1

Choose simplicity by using the utility type Record<Keys, Type>:

type YourObjectType = {
  edges: Record<string, { name: string }>
}

answered Jan 9, 2024 at 9:17

Penny Liu

18k5 gold badges89 silver badges109 bronze badges

Collectives™ on Stack Overflow

Defining object type without knowing properties keys in TypeScript

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related