Express unknown string object key in TypeScript

Question

I'm creating a TypScript Declaration file for a client library with a method that returns an object having a variable string key (a record id):

getRecords(...): {
  [string]: {  // ??
    first: string,
    last: string,
    ...
  }
};

What is the correct way to specify that the key value is only known at runtime, and what is the reference for this?

getRecords returns something like:

{
  'GuT9b...pX': {
    first: 'John',
    last: 'Doe',
    ...
  },
  'aMe4T...lk': {
    first: 'Jane',
    last: 'Doe',
    ....
  }
}

_{(Note that this is a wrapper for an HTTP API written in PHP so I have no control over the result being an associative array (i.e. JavaScript hash), instead of an array with an .id field in each element.)}

It's unclear what you're asking. Can you show a real example? — Nitzan Tomer
– Nitzan Tomer, Commented Jun 17, 2017 at 20:13

Dan Dascalescu · Accepted Answer · 2017-06-17 20:54:37Z

1

It's called indexable type:

function getRecords(key: string): { [s: string]: { first: string /*, ...*/ } } {
    return { [key]: { first: 'John' } }
}

edited Jun 17, 2017 at 20:54

Dan Dascalescu

154k66 gold badges336 silver badges422 bronze badges

answered Jun 17, 2017 at 20:38

artem

52.2k10 gold badges86 silver badges85 bronze badges

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

Collectives™ on Stack Overflow

Express unknown string object key in TypeScript

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