Implement an interface with a specific number of properties in TypeScript

Question

Implement an interface with a specific number of properties in TypeScript

I am attempting to create a custom type that defines an object with a specific number of key-value pairs, where both the key and value are required to be numbers. Here is what I envision:

type MatchResult = {
  [key: number]: number;
  [key: number]: number;
}

This particular type is meant to represent the result of a match between two teams, with the team ID as the key and the number of goals scored as the value (a practical application of this type).

However, there is an issue in the example above - it's not valid to have multiple index types defined.

typescript

Answer 1

Answer №1

If you're unsure of the keys in advance, they can be any number, allowing for a dynamic setup:

type MatchResult = {
 [key: number]: number
}

However, if you know the keys beforehand, you can specify them explicitly like so:

type MatchResult = {
 111: number,
 222: number
}

This enables accessing values using a[111], but not with undefined keys like a[232] assuming a is of type MatchResult.

Creating a type with exactly 2 integer keys may not be achievable in TypeScript as it would require contextual tracking of each object with type MatchResult.

A more practical approach would be defining a specific type, such as:

type TeamResult {
 id: number;
 result: number;
}

type MatchResult {
 host: TeamResult;
 guest: TeamResult;
}

Answer 2

If you're unsure of the keys in advance, they can be any number, allowing for a dynamic setup:

type MatchResult = {
 [key: number]: number
}

However, if you know the keys beforehand, you can specify them explicitly like so:

type MatchResult = {
 111: number,
 222: number
}

This enables accessing values using a[111], but not with undefined keys like a[232] assuming a is of type MatchResult.

Creating a type with exactly 2 integer keys may not be achievable in TypeScript as it would require contextual tracking of each object with type MatchResult.

A more practical approach would be defining a specific type, such as:

type TeamResult {
 id: number;
 result: number;
}

type MatchResult {
 host: TeamResult;
 guest: TeamResult;
}

Implement an interface with a specific number of properties in TypeScript

Answer №1

Similar questions

Issue: The variable 'HelloWorld' has been declared but not utilized

Move information from one page to another

Ensuring the selected date matches any consecutive dates within the dates array in Angular

Typescript Error: Issue encountered while passing props. Unable to access properties as they are undefined

Absolute imports in create-react-app do not function properly when using yarn v2 workspaces alongside typescript

In Next.js, a peculiar issue arises when getServerSideProps receives a query stringified object that appears as "[Object object]"

Experiencing difficulties with the mat-card component in my Angular project

Function modifies global variable

The correct method for recording a personalized directive with added functionality using the then function

What is the best way to incorporate an interface in TypeScript that is both callable and has properties?

Can you explain the meaning of `images:Array<Object> = [];` in TypeScript?

TestCafe Environment Variables are not properly defined and displaying as undefined

Determine the data type of a parameter by referencing a prior parameter

Creating dynamic HTML in Angular 2 can be achieved by utilizing directives, data

Vue 3 - Compelled to utilize any data type with computedRef

Restrict the frequency of requests per minute using Supertest

Backend communication functions seamlessly within the service scope, yet encounters obstacles beyond the service boundaries

Develop customizable enumerations for use in expandable interfaces

Changing a complex object within a nested array of a BehaviorSubject

Here is a unique version: "Dealing with Node.js ES6 (ESM) Modules in TypeScript can be tricky, especially when the TypeScript Compiler (TSC) fails to emit the