Allow index [key: string] to be typed - only allow certain strings for the index

[ORESoftware]

Search Terms

keyof arrays typeof index

Suggestion

const Events = <const> [
  'repo:push',
  'pullrequest:unapproved',
  'pullrequest:created'
];

type MyEvents = typeof Events[number];

export interface InterosTag {
  [key: string]: {
    [key: keyof MyEvents]: {   // this part does not work
      "jenkins-job": string,
      "deploy": boolean,
      "eks-key": string
    }
  }
}

Examples

I am trying to create a type for this:

const needsTypeInfo = {
      "events": {
              "repo:push": {
                "jenkins-job": "build_entity_tools",
                "deploy": false,
                "eks-key": "entity-tools"
            },
              "pullrequest:unapproved": {
                "jenkins-job": "build_entity_tools",
                "deploy": false,
                "eks-key": "entity-tools"
            },
            "pullrequest:unapprovedXXX": {
                "jenkins-job": "build_entity_tools",
                "deploy": false,
                "eks-key": "entity-tools"
            }
      }     
}

the key with XXX should fail because it's not in the list:

const Events = <const> [
  'repo:push',
  'pullrequest:unapproved',
  'pullrequest:created'
];

Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

[fatcerberus]

#26797

[ORESoftware]

Yeah in particular, I was hoping that this would work as is:

const Events = [
  'pullrequest:rejected',
  'pullrequest:fulfilled',
  'pullrequest:created'
];

export interface InterosTag {
    [key: keyof Events]: {    // use keyof here (or some related operator)
      "jenkins-job": string,
      "deploy": boolean,
      "eks-key": string
   }
}