Enum inside class (TypeScript definition file)
I've searched around but can't seem to find an answer for this, hopefully you can help.
How can I add an enum to Image
? This is what I would like ideally but I get an error.
declare module 'Lib' {
export module Graphics {
export class Image {
enum State {}
static STATE_IDLE: State;
static STATE_LOADING: State;
static STATE_READY: State;
static STATE_ERROR: State;
constructor();
}
}
}
If I move State
into the Graphics
module it works but now State
belongs to Graphics
, which is incorrect. It needs to be part of Image
.
I think the following is an improvement on KoenT's solution:
export class Image
{
constructor ()
{
this.state = Image.State.Idle;
}
state: Image.State;
}
export namespace Image
{
export enum State
{
Idle,
Loading,
Ready,
Error
}
}
The advantage being that you can leverage named imports:
import {Image} from './image';
let img = new Image()
img.state = Image.State.Error
Here's my solution.
program.ts:
enum Status {
Deleting,
Editing,
Existing,
New
}
export class Program {
static readonly Status = Status;
readonly Status = Program.Status;
title: string;
status: Status;
constructor(init?: Partial<Program>) {
Object.assign(this, init);
}
}
Usage:
let program = new Program({ title: `some title` });
program.status = Program.Status.New;
or
program.status = program.Status.New;
Added benefit for Angular 2+ users: this can be used in templates
<div *ngIf="program.status === program.Status.New">
Only display if status of the program is New
</div>
I also bumped into this problem recently. This is what I am currently using as a solution:
// File: Image.ts
class Image
{
constructor()
{
this.state = Image.State.Idle;
}
state: Image.State;
}
module Image
{
export enum State
{
Idle,
Loading,
Ready,
Error
}
}
export = Image;
Then in the place where I'm using the class and its enum:
import Image = require("Image");
let state = Image.State.Idle;
let image = new Image();
state = image.state;
This seems to work fine (even though I don't consider it as the expected way to do this kind of thing).
Hopefully there will be a way in TypeScript to do it this way:
class Image
{
enum State
{
Idle,
Loading,
Ready,
Error
}
constructor()
{
this.state = State.Idle;
}
state: State;
}
export = Image;