Connect the keys from one enum to either keys or values in another enum

Question

Connect the keys from one enum to either keys or values in another enum

When working with the code below, it is important that the keys of PropertiesNamesInDataBase align with those in User.Keys. While the values of PropertiesNamesInDataBase are used in the backend, it is crucial for uniformity that the names match in the frontend.

namespace User {
    export enum Keys {
        ID = "ID",
        name = "name"
    }
}

enum PropertiesNamesInDataBase {
    ID = "id",
    name = "nm"
}

This setup poses at least two challenges:

We may have to manually retype or copy-paste the keys
PropertiesNamesInDataBase operates independently from User.Keys, but ideally, the keys in PropertiesNamesInDataBase should somehow reference User.Keys.

To address the second issue, one solution is to associate the keys in PropertiesNamesInDataBase with those in User.Keys:

namespace User {
    export enum Keys {
        ID = "ID",
        name = "name"
    }
}

enum PropertiesNamesInDataBase {
    [User.Keys.ID] = "id",
    [User.Keys.name] = "nm"
}

However, TypeScript does not support this approach:

Computed property names are not allowed in enums. (1164)

If you have any ideas on how to efficiently reuse enum keys or reference PropertiesNamesInDataBase's keys based on User.Keys's values, please share your suggestions.

typescript enums

Answer 1

Answer №1

If you're considering abandoning the use of enum, one alternative is to create your own enum-like objects for added flexibility. While this approach allows you to define keys only once, it does come with a trade-off – you will lose some of the built-in expressiveness that comes with using enum.

Here's an example of how you can implement this:

const KeysAndPropNames = {
  ID: { key: "ID", propName: "id" },
  name: { key: "name", propName: "nm" }
} as const;

This single object maps keys to values similar to what you had in your previous User.Keys and PropertiesNamesInDataBase enums. You can extract these enum-like objects like this:

const User = { Keys: objMapProp(KeysAndPropNames, "key") };
const PropertiesNamesInDataBase = objMapProp(KeysAndPropNames, "propName");

The function objMapProp() helps map a property access over an object:

// Library Function
function objMapProp<T extends Record<keyof T, Record<K, any>>, K extends keyof any>(
  obj: T,
  key: K
) {
  const ret = {} as { [P in keyof T]: T[P][K] };
  for (let k in obj) {
    ret[k] = obj[k][key];
  }
  return ret;
}

If you check the types of the new User and PropertiesNamesInDataBase objects using IntelliSense, you'll see they align with the old values.

To create the corresponding types named User.Keys and PropertiesNamesInDataBase, you can define them as follows:

namespace User {
  export type Keys = (typeof User.Keys)[keyof typeof User.Keys];
  // type User.Keys = "ID" | "name"
}
type PropertiesNamesInDataBase = typeof PropertiesNamesInDataBase[keyof typeof PropertiesNamesInDataBase];
// type PropertiesNamesInDataBase = "id" | "nm"

I hope this solution either fulfills your requirements or guides you on how to progress further. Best of luck!

Playground link to code

Answer 2

If you're considering abandoning the use of enum, one alternative is to create your own enum-like objects for added flexibility. While this approach allows you to define keys only once, it does come with a trade-off – you will lose some of the built-in expressiveness that comes with using enum.

Here's an example of how you can implement this:

const KeysAndPropNames = {
  ID: { key: "ID", propName: "id" },
  name: { key: "name", propName: "nm" }
} as const;

This single object maps keys to values similar to what you had in your previous User.Keys and PropertiesNamesInDataBase enums. You can extract these enum-like objects like this:

const User = { Keys: objMapProp(KeysAndPropNames, "key") };
const PropertiesNamesInDataBase = objMapProp(KeysAndPropNames, "propName");

The function objMapProp() helps map a property access over an object:

// Library Function
function objMapProp<T extends Record<keyof T, Record<K, any>>, K extends keyof any>(
  obj: T,
  key: K
) {
  const ret = {} as { [P in keyof T]: T[P][K] };
  for (let k in obj) {
    ret[k] = obj[k][key];
  }
  return ret;
}

If you check the types of the new User and PropertiesNamesInDataBase objects using IntelliSense, you'll see they align with the old values.

To create the corresponding types named User.Keys and PropertiesNamesInDataBase, you can define them as follows:

namespace User {
  export type Keys = (typeof User.Keys)[keyof typeof User.Keys];
  // type User.Keys = "ID" | "name"
}
type PropertiesNamesInDataBase = typeof PropertiesNamesInDataBase[keyof typeof PropertiesNamesInDataBase];
// type PropertiesNamesInDataBase = "id" | "nm"

I hope this solution either fulfills your requirements or guides you on how to progress further. Best of luck!

Playground link to code

Connect the keys from one enum to either keys or values in another enum

Answer №1

Similar questions

Having difficulty ensuring DayJs is accessible for all Cypress tests

Is it necessary for the React generic type prop to be an extension of another type

The sanitizer variable becomes null when accessed outside of the NgOnInit function in Angular using TypeScript

How can I customize the visibility toggles for the password input field in Angular Material?

I'm experiencing an issue with redirect in Nextjs that's causing an error message to appear. The error reads: "SyntaxError: JSON.parse: unexpected character at line 1 column 1 of the JSON data

Using TypeScript to assign values to object properties

The constant value being brought in from an internal npm package cannot be determined

What methods are recommended for implementing changes in a TypeScript library throughout the development process?

Steps for accessing the camera within a custom Ionic app

Is it possible to access the service and 'self' directly from the HTML template?

Troubleshooting a Custom Pipe Problem in Angular Material Drag and Drop

Can someone provide a description for a field within typedoc documentation?

Dealing with challenges in integrating ngx-masonry with Angular 14

Are there any comparable features in Angular 8 to Angular 1's $filter('orderBy') function?

Upon completion of a promise in an express middleware and breaking out of a loop, a 404 error is returned

What methods can I use to analyze the integrity of the data's structure?

What is the purpose of the tabindex in the MUI Modal component?

Experiencing a compilation issue while attempting to apply the class-transformer

Title remains consistent | Angular 4

Error: 'process' is not defined in this TypeScript environment