Typescript: define type of an object

Question

I want to define the type of an Object literal, with key valye pairs, like below. In any way can't manage this. Please help.

export const endPoints: {name: string: {method: string; url: string;}} = {
  allFeed: {
    method: 'GET',
    url: 'https://www.yammer.com/api/v1/messages.json'
  },
  topFeed: {
    method: 'GET',
    url: 'https://www.yammer.com/api/v1/messages/algo.json'
  },
  followingFeed: {
    method: 'GET',
    url: 'https://www.yammer.com/api/v1/messages/following.json'
  },
  defaultFeed: {
    method: 'GET',
    url: 'https://www.yammer.com/api/v1/messages.json/my_feed.json'
  }
};

Nitzan Tomer · Accepted Answer · 2016-07-28 08:40:08Z

2

You're very close, should be:

const endPoints: { [name: string]: { method: string; url: string; } } = {
    allFeed: {
        method: 'GET',
        url: 'https://www.yammer.com/api/v1/messages.json'
    },
    ...
};

You can also use interfaces:

interface EndPoint {
    method: string;
    url: string;
}

interface EndPointMap {
    [name: string]: EndPoint;
}

const endPoints: EndPointMap = {
    ...
}

Or types:

type EndPoint = {
    method: string;
    url: string;
}

type EndPointMap = {
    [name: string]: EndPoint;
}

const endPoints: EndPointMap = {
    ...
}

Which makes the code more readable in my opinion (when compared to the inline way of declaring the type)

answered Jul 28, 2016 at 8:40

Nitzan Tomer

166k51 gold badges330 silver badges307 bronze badges

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

1 Comment

Arnab Das Over a year ago

Thank you very much. :-)

Collectives™ on Stack Overflow

Typescript: define type of an object

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related