Establish an enumeration using universally recognized identifiers

Question

Establish an enumeration using universally recognized identifiers

I have a JavaScript function that requires a numerical input, as well as some predefined constants at the top level:

var FOO = 1;
var BAR = 2;

The function should only be called using one of these constants.

To ensure type safety in TypeScript, I am attempting to create an interface using an enum:

declare enum MyType {
    FOO,
    BAR
}

interface MyClass {
    process(MyType type);
}

However, when the code is compiled, it outputs MyType.FOO in the JavaScript file. Is there a way to make it output just FOO while still maintaining type safety in TypeScript?

enums typescript

Answer 1

Answer №1

// Version X
const enum _YourType {
    APPLE,
    ORANGE
}
let APPLE = _YourType.APPLE;
let ORANGE = _YourType.ORANGE;

or

// Version Y (if APPLE and ORANGE are imported from another module)
declare const enum _YourType {
    APPLE,
    ORANGE
}
declare let APPLE: _YourType;
declare let ORANGE: _YourType;

Either way,

function myFunction(y: _YourType) { /* ... */ }

myFunction(APPLE); // OK
myFunction('banana'); // Error

Answer 2

// Version X
const enum _YourType {
    APPLE,
    ORANGE
}
let APPLE = _YourType.APPLE;
let ORANGE = _YourType.ORANGE;

or

// Version Y (if APPLE and ORANGE are imported from another module)
declare const enum _YourType {
    APPLE,
    ORANGE
}
declare let APPLE: _YourType;
declare let ORANGE: _YourType;

Either way,

function myFunction(y: _YourType) { /* ... */ }

myFunction(APPLE); // OK
myFunction('banana'); // Error

Establish an enumeration using universally recognized identifiers

Answer №1

Similar questions

The exported variable 'SAlert' is utilizing the name 'AlertInterface' from an external module

Is there a way to invoke a client-side function from the server?

Angular component name constraints - 'the selector [your component name] is not permissible'

Is the Typescript index signature limited to only working with the `any` type?

Script - Retrieve the content of the code element

The React Hook Form's useFieldArray feature is causing conflicts with my custom id assignments

Facilitating the integration of both Typescript and JavaScript within a Node application

tips for concealing a row in the mui data grid

Cannot display data in template

New Requirement for Angular Service: Subclass Constructor Must Be Provided or Unable to Resolve all Parameters for ClassName (?)

Is there a way for me to retrieve the bodyHeight attribute of ag-grid using public variables or data?

Exploring JSON data in real-time

For each array element that is pushed, create and return an empty object

Leveraging Ionic 2 with Moment JS for Enhanced TimeZones

Using Next.js, it is not possible to use absolute imports within SASS

Error: Unable to access $rootScope in the http interceptor response function

Problem with Jasmine in Angular 5 within Visual Studio Code

Utilize the key types of an object to validate the type of a specified value within the object

Avoiding the use of reserved keywords as variable names in a model

Modify the interface type whilst maintaining the structure of nested objects