Typescript: Type of a property dependent on another property within the same object

by

I think what you are actually looking for is a discriminated union. IObject should itself be a union:

export type IObject = {
    type: "checked"
    parameters: IParametersCheck
} | {
    type: "counter"
    parameters: IParametersCounter
}
export type ObjectType = IObject['type'] //// in case you need this union
export type ObjectParameters = IObject['parameters']  //// in case you need this union

export interface IParametersCheck {
    checked: boolean
}
export interface IParametersCounter {
    max: number
    min: number
    step: number
}

You could also do it with conditional types but I think the union solution works better :

export interface IObject<T extends ObjectType> {
    type: T
    parameters: T extends 'checked' ? IParametersCheck: IParametersCounter
}

Or with a mapping interface:

export interface IObject<T extends ObjectType> {
    type: T
    parameters: ParameterMap[T]
}
type ParameterMap ={
    'checked': IParametersCheck
    'counter': IParametersCounter
}

export type ObjectType = keyof ParameterMap

More Related Contents:

  1. TypeScript conditional types – filter out readonly properties / pick only required properties
  2. How do I type an object with known and unknown keys in TypeScript
  3. Why does a Typescript type conditional on `T extends undefined`, with T instantiated with `boolean`, resolve T to `never`?
  4. ‘unknown’ vs. ‘any’
  5. typescript interface require one of two properties to exist
  6. The property ‘value’ does not exist on value of type ‘HTMLElement’
  7. What is the question mark for in a Typescript parameter name
  8. How to pass optional parameters while omitting some other optional parameters?
  9. Angular 2 Show and Hide an element
  10. Types for function that applys name of function and arguments
  11. Typescript: How can I make entries in an ES6 Map based on an object key/value type
  12. Typescript Interface – Possible to make “one or the other” properties required?
  13. Difference between ‘object’ ,{} and Object in TypeScript
  14. Forcing excess-property checking on variable passed to TypeScript function
  15. How to reject in async/await syntax?
  16. Typescript: Type ‘string | undefined’ is not assignable to type ‘string’
  17. Angular2 – Share data between components using services
  18. Using jQuery plugin in TypeScript
  19. How to get type of array items?
  20. Naming of TypeScript’s union and intersection types
  21. Jest won’t transform the module – SyntaxError: Cannot use import statement outside a module
  22. TypeScript sorting an array
  23. “An index signature parameter type cannot be a union type.” – what should I use instead?
  24. Detailed differences between type annotation `variable: type` and type assertion `expression as type` in TypeScript
  25. Generic and typeof T in the parameters
  26. How to make “handler” lookup for “dispatcher” style function be typed correctly
  27. How do I decide whether @types/* goes into `dependencies` or `devDependencies`?
  28. How to define an interface for objects with dynamic keys?
  29. Types from both keys and values of object in Typescript
  30. Modules vs. Namespaces: What is the correct way to organize a large typescript project?

Leave a Comment