Get value from object of unknown content by key in typescript

Question

I'm writing function that'll return single value from object by key or return empty object if key does not exist.

Code:

//example data:
const obj = {
    data: {test: 'word'},
    str: 'Hi',
    num: 22,
}

const pickOne = <T extends object>(obj: T, key: keyof typeof obj) => ((key in obj) ? obj.key : {})

console.log(pickOne(obj, 'data')) //should print {test: 'word'}

My problem is that I get this error: Property 'key' does not exist on type 'T'. I'm new to typescript but after reading docs I was sure that keyof typeof would allow any key in obj.

Any help would be appreciated, thanks.

It is worth using T extends Record<string, unknown> instead of T extends object. Because object is very wide type — captain-yossarian from Ukraine
– captain-yossarian from Ukraine, Commented May 14, 2022 at 6:38

Matheus Felipe · Accepted Answer · 2022-05-13 21:35:54Z

2

Your obj has 3 keys:

data
str
num

When you write obj.key you are telling the interpreter to find a key called key, which does not exist.

On the other hand you can access these keys by its name using brackets:

const key = "data"
obj[key] // Should return {test: 'word'} , which is equivalent to:
obj["data"] // Should return {test: 'word'}

Moral of the story:

The dot-notation is to access existing keys in a given object
- If the key exists it works. Otherwise, it errors out
TypreScript also allows accessing these keys by name
- If the key exists it works. Otherwise, doesn't error out but returns undefined

Working example:

const obj = {
    data: {test: 'word'},
    str: 'Hi',
    num: 22,
}

const key = "data"
console.log(obj[key])
console.log(obj["data"])
console.log(obj["key"])

answered May 13, 2022 at 21:35

Matheus Felipe

2,58227 silver badges24 bronze badges

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

Comments

Alex Wayne · Accepted Answer · 2022-05-13 20:20:20Z

1

This:

obj.key

gets the property named "key" on obj, which may not exist.

Where this:

obj[key]

Gets the property name in the variable key.

Which works without type error: See playground

answered May 13, 2022 at 20:20

Alex Wayne

188k52 gold badges328 silver badges363 bronze badges

Collectives™ on Stack Overflow

Get value from object of unknown content by key in typescript

2 Answers 2

Moral of the story:

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Moral of the story:

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related