Techniques for updating the names of interface keys?

Question

Techniques for updating the names of interface keys?

One task involves renaming keys within an interface while accounting for variations in nesting levels. Consider the following example:

interface Foo {
  _id: string
  nested: {
    _id: string
    nested: {
      _id: number
    }
  }
}

// How can a new type be created to match the structure below?

type Bar = {
  id: string
  nested: {
    id: string,
    nested: {
      id: number
    }
  }
}

In this scenario, the goal is to change all instances of _id to id, while keeping the type unchanged.

typescript types

Answer 1

Answer №1

Give this type a try:

// Define the PickRename type that renames keys in an object

type PickRename<T, K extends string, R extends string> =
  T extends object ? K extends keyof T ?
  ({ [P in R]: PickRename<T[K], K, R> } &
    { [P in Exclude<keyof T, K>]: PickRename<T[P], K, R> }) extends infer I ?
  { [PP in keyof I]: I[PP] } : never
  : T
  : T

Explanation with an example:

If T is an object and key K (for instance, "_id") exists, process the object by changing the key names.
Remove the existing key K and replace it with the new name R; recursively update each property as needed.
The syntax
```
extends infer I ? { [PP in keyof I]: I[PP] } : never 
```
is for clarity and readability of the intersected types.

/*
type T1 = {
    id: string;
    nested: {
        id: string;
        nested: {
            id: number;
        };
    };
}
*/
type T1 = PickRename<Foo, "_id", "id">

To alter multiple properties at once, explore different PickRename implementations here.

Dive into the TypeScript playground here.

Answer 2

Give this type a try:

// Define the PickRename type that renames keys in an object

type PickRename<T, K extends string, R extends string> =
  T extends object ? K extends keyof T ?
  ({ [P in R]: PickRename<T[K], K, R> } &
    { [P in Exclude<keyof T, K>]: PickRename<T[P], K, R> }) extends infer I ?
  { [PP in keyof I]: I[PP] } : never
  : T
  : T

Explanation with an example:

If T is an object and key K (for instance, "_id") exists, process the object by changing the key names.
Remove the existing key K and replace it with the new name R; recursively update each property as needed.
The syntax
```
extends infer I ? { [PP in keyof I]: I[PP] } : never 
```
is for clarity and readability of the intersected types.

/*
type T1 = {
    id: string;
    nested: {
        id: string;
        nested: {
            id: number;
        };
    };
}
*/
type T1 = PickRename<Foo, "_id", "id">

To alter multiple properties at once, explore different PickRename implementations here.

Dive into the TypeScript playground here.

Techniques for updating the names of interface keys?

Answer №1

Explanation with an example:

Similar questions

The React Functional Component undergoes exponential re-renders when there is a change in the array

The property 'name' is not found within the type 'FormGroup'

Searching for values within an array of objects by iterating through nested arrays to apply a filter

Ways to expand the inheritance of a family's assets in the next generation

Deduce the generic types of child components based on the type of the

Tips for effectively utilizing the Angular ngIf directive for toggling the visibility of elements

The TypeScript compiler remains silent when a declaration is missing

Using Typescript to set a custom timeout duration based on a dynamic variable within a for loop

Opening and closing a default Bootstrap modal in Angular 2

Dealing with reactive form controls using HTML select elements

Adding jQuery and other libraries to Typescript for optimal functionality

The combination of TypeScript decorators and Reflect metadata is a powerful tool for

Is there a way to identify the specific button that was clicked within an Angular Material dialog?

An unexpected problem in Mongoose and Typescript

Issue with Component in Angular not functioning properly with proxy construct trap

Ways to specify an unused parameter within a function

Error: Unable to initialize i18next as a function

Problem of Restricting Array to Single Element at Once

Attempting to clear the value of a state property using the delete method is proving to be ineffective

Dispatching an asynchronous function error in React with TypeScript and Redux - the parameter type is not assignable to AnyAction