Is it possible to define a constant enum within a TypeScript class?

Question

Is it possible to define a constant enum within a TypeScript class?

I am looking for a way to statically set an enum on my TypeScript class and be able to reference it both internally and externally by exporting the class. As I am new to TypeScript, I am unsure of the correct syntax for this. Below is some pseudo-code (which extends a Backbone Model) that outlines what I am trying to achieve...

class UnitModel extends Backbone.Model {
    static enum UNIT_STATUS {
        NOT_STARTED,
        STARTED,
        COMPLETED
    }

    defaults(): UnitInterface {
        return {
            status: UNIT_STATUS.NOT_STARTED
        };
    }


    isComplete(){
        return this.get("status") === UNIT_STATUS.COMPLETED;
    }

    complete(){
        this.set("status", UNIT_STATUS.COMPLETED);
    }
}

export = UnitModel;

I want to access the enum inside this class as well as outside the class, such as shown below:

import UnitModel = require('path/to/UnitModel');
alert(UnitModel.UNIT_STATUS.NOT_START);//I expect to see 0 since enums start at 0

javascript class backbone.js enums typescript

Answer 1

Answer №1

To achieve this goal, it is important to declare the property outside of the class and then set it as a static attribute.

enum TASK_STATUS {
    NOT_INITIALIZED,
    IN_PROGRESS,
    DONE,
}

class TaskModel extends Backbone.Model {

    static TASK_STATUS = TASK_STATUS;

    isTaskComplete(){
        return this.get("status") === TASK_STATUS.DONE;
    }
}

export = TaskModel;

Answer 2

To achieve this goal, it is important to declare the property outside of the class and then set it as a static attribute.

enum TASK_STATUS {
    NOT_INITIALIZED,
    IN_PROGRESS,
    DONE,
}

class TaskModel extends Backbone.Model {

    static TASK_STATUS = TASK_STATUS;

    isTaskComplete(){
        return this.get("status") === TASK_STATUS.DONE;
    }
}

export = TaskModel;

Answer 3

Answer №2

If you're looking to declare a namespace along with your class, one way to do it is by placing the enum inside the namespace itself. Here's an example of how you can achieve this:

class ItemModel extends Backbone.Model {
    defaults(): ItemInterface {
        return {
            status: ITEM_STATUS.PENDING
        };
    }

    isApproved(){
        return this.get("status") === ITEM_STATUS.APPROVED;
    }

    approve(){
        this.set("status", ITEM_STATUS.APPROVED);
    }
}

namespace ItemModel {
    export enum ITEM_STATUS {
        PENDING,
        APPROVED,
        REJECTED
    }
}

export = ItemModel;

After that, you can simply access your enum using ItemModel.ITEM_STATUS.

Answer 4

If you're looking to declare a namespace along with your class, one way to do it is by placing the enum inside the namespace itself. Here's an example of how you can achieve this:

class ItemModel extends Backbone.Model {
    defaults(): ItemInterface {
        return {
            status: ITEM_STATUS.PENDING
        };
    }

    isApproved(){
        return this.get("status") === ITEM_STATUS.APPROVED;
    }

    approve(){
        this.set("status", ITEM_STATUS.APPROVED);
    }
}

namespace ItemModel {
    export enum ITEM_STATUS {
        PENDING,
        APPROVED,
        REJECTED
    }
}

export = ItemModel;

After that, you can simply access your enum using ItemModel.ITEM_STATUS.

Is it possible to define a constant enum within a TypeScript class?

Answer №1

Answer №2

Similar questions

What is the method for retrieving a class's property without creating an object instance?

Sending a JS function to a PHP script

How to outsmart the TypeScript compiler when integrating a library without type definitions?

Don't forget to save the selected date in the datepicker

The function JSON.parse(data) may result in an undefined value being returned

Error occurred during download or resource does not meet image format requirements

Reflector has no definition in three.js - a software mystery

An error popped up: "argument list is missing) after"

Encountered a Solana Error while handling Instruction 2: custom program error with code 0x1000078

Angular 2: Enhancing Textareas with Emoji Insertion

Executing a command upon the pressing of the enter key within a text input field

How can you simulate a 'click' event on the currently active tab of a jQuery tab?

The MUI Select component requires two clicks to open its menu if another Select component's menu is already open

What could be causing the delay in $q.all(promises).then() not waiting for the promises to complete?

Conceal the div if it remains unhidden within the following 10 seconds

steps for linking a directive variable to a controller

Send the values of the form variables as arguments

The webpage's Document Object Model fails to refresh following a JavaScript modification

How can Angular prevent displaying 404 errors in the console by utilizing fallback mechanisms?

Stopping free jqgrid disabled toolbar buttons from reacting to mouse clicks can be achieved by implementing specific coding techniques that