Suparnar Taina

Suparnar Taina

1582263000

What is Enum in Typescript?

Introduction

In this article you will learn about Enum in Typescript in detail. This article will help beginners to understand the concept.

What is Enum?

  • The short form of enumeration is enum.
  • It is used as a type with some set of values called a named constant.
  • Inernally it holds numeric type values or in some cases we can create heterogeneous enums.
  • The enum keyword is used to define the enums.
  • We can create a distinct case so it makes it easy to document.
  • It forces us to use all possible values.
  • Access the enums using index or use dot operator after the enum name & named constant.
  • Initial value starts from 0 if we do not set any value.
  • Auto incremental is the best approach to use because we do not need to worry about the values.

Syntax

enum enumName{  
constant1, constant2, constant3...  
}  

Example

Consider  traffic signal lights as an example.

This is image title

We can access the elements using index or by constant name:

enum signalLights{  
   red, yellow, green  
}  
let result: string = signalLights[signalLights.red];  
console.log(result);  
console.log(signalLights[1]);  
let output: signalLights = (<any>signalLights)["yellow"];  
console.log(output);  

Output

red
yellow
1

Types of enums

Numeric enum

  • It is commonly used in all languages.
  • Initial value starts from 0 if we do not set any value.
  • Takes only numeric values.
  • enum keyword is used to declare the numeric type enum.
  • We can assign any value as per our requirements.
  • If our function returns any numeric value then we can use this function to initialize the constant.

Consider that in the below rainbowColors is enum & we have not initialized any constants, so it will starts with 0 value and the rest of the constants have auto increamemtal values.

**Example **

enum rainbowColors {  
    Red,  
    Orange,  
    Yellow,  
    Green,  
    Blue,  
    Indigo,  
    Violet,  
}  
console.log("color & index value is as follows");  
for (let item in rainbowColors) {  
    if (isNaN(Number(item))) {  
        console.log(item + " : " + < rainbowColors > rainbowColors[item]);  
    }  
}   

Output

color & index value is as follows:

Red : 0
Orange : 1
Yellow : 2
Green : 3
Blue : 4
Indigo : 5
Violet : 6

Consider the below example, rainbowColors is enum & the second element is initialized with value 1000. So it will be auto incremental to the  remaining constants. It will print on the console.

**Example **

enum rainbowColors {  
    Red,  
    Orange = 1000,  
    Yellow,  
    Green,  
    Blue,  
    Indigo,  
    Violet,  
}  
console.log("color & index value is as follows");  
for (let item in rainbowColors) {  
    if (isNaN(Number(item))) {  
        console.log(item + " : " + < rainbowColors > rainbowColors[item]);  
    }  
}   

Output

color & index value is as follows,

Red : 0
Orange : 1000
Yellow : 1001
Green : 1002
Blue : 1003
Indigo : 1004
Violet : 1005

Using function in enum

Consider the below example. We can use function in enum if we are returning the value from the function. It is used when the user needs to do any calculation. Suppose we need to calculate the total minutes like 1 hour = 60 minute, 2 hour = 120 minute, then it will create one function which will do a calcuation & return values to enum constant:

Example

function Totalminute(hr: number): any{  
return 60 * hr;  
}  
enum hours  
{  
One = Totalminute(1) ,  
Two = Totalminute(2),  
Three = Totalminute(4),  
}  
console.log(hours.One);  
console.log(hours.Two);  
console.log(hours.Three);  

Output

60
120
240

String enum

It is same as the numeric enums,  we are just passing string values/literals to our enum constant. enum keyword is used to declare the enums.

Consider the below example, our vehicle is taking different kinds of turns, and we will define the enum as:

Example

enum vehicleTurn {  
    Left = "Left",  
        Right = "Right",  
        UTurn = "UTurn"  
}  
console.log(vehicleTurn.Left);  
console.log(vehicleTurn.Right);  
console.log(vehicleTurn.UTurn);  
}   

Output

Left
Right
UTurn

Heterogeneous enums

Typescript allows us to create a mixed type of enums.

This means we can assign numeric & string type values to enum.

Consider the below example, circleInfo has heterogeneous enum values.

Example

enum circleInfo {  
    Area = "area of circle",  
        Pie = 3.112,  
        Radius = 20  
}  
let result = circleInfo.Pie * circleInfo.Radius * circleInfo.Radius;  
console.log(circleInfo.Area + " is :" + result); 

Output

area of circle is :1244.8

Point A - Function & interface using enum

Consider the below example, clothSize is enum which contains some constants. IClothSize is an interface which contains two properties, key & value, having string & number type respectively.

Function is taking enum as a parameter & will print the data on the console.

Example

enum clothSize {  
    small,  
    medium,  
    large  
}  
interface IClothSize {  
    key: string,  
        value: number  
}  
  
function getClothSize(size: clothSize): IClothSize {  
    switch (size) {  
        case clothSize.small:  
            return {  
                key: clothSize[clothSize.small], value: 10  
            };  
        case clothSize.medium:  
            return {  
                key: clothSize[clothSize.medium], value: 20  
            };  
        case clothSize.large:  
            return {  
                key: clothSize[clothSize.large], value: 30  
            };  
    }  
}  
console.log("cloth is " + getClothSize(clothSize.small).key + " & value is " + getClothSize(clothSize.small).value);  
console.log("cloth is " + getClothSize(clothSize.medium).key + " & value is " + getClothSize(clothSize.medium).value);  

Output

cloth is small & value is 10

cloth is medium & value is 20

Point B - const enum

  • Typescript allows us to declare const enum.
  • const keyword is used.
  • It has a inlined values.
  • We can access enum using enum[‘ConstantName’]

Example

const enum myColor {  
    Red = 10,  
        White = Red * 4,  
        Blue = White + 10,  
        Yellow,  
}  
console.log(myColor.Red)  
console.log(myColor.White)  
console.log(myColor.Blue)  
console.log(myColor['Yellow'])   

Output

10
40
50
51

We will not be able to access enum using index in const enum like myColor[0], it will give us an error.

Point C

ES6 allows us to use map enum keys.

Example

enum classes {  
    I,  
    II,  
    III,  
    IV,  
    V  
}  
const ClassNames = new Map < number,  
    string > ([  
        [classes.I, '100'],  
        [classes.II, '200'],  
        [classes.III, '300'],  
    ]);  
console.log(ClassNames);   

Output

Map(3) {0 => “100”, 1 => “200”, 2 => “300”}

We will modify the above example, we can use this into a classes as below.

Note

User can modify the code as per their requirement.

Example

enum classes {  
    I,  
    II,  
    III,  
    IV,  
    V  
}  
const ClassNames = new Map < number,  
    string > ([  
        [classes.I, '100'],  
        [classes.II, '200'],  
        [classes.III, '300'],  
    ]);  
class AllStandards {  
    public allNames: object;  
    constructor() {  
        this.allNames = ClassNames;  
    }  
}  
let obj: AllStandards = new AllStandards();  
console.log(obj.allNames);   

Output

Map(3) {0 => “100”, 1 => “200”, 2 => “300”}

Point D - export enum

  • typescript allows us to export the enum.
  • export keyword is used before the enum.
  • import is used to import that enum file.

We can declare the enum like this:

export enum sportActivities {Football, Cricket,Badminton, Tennis}  

To import the enum in .ts,  i.e.; typescript file looks like this:

import {sportActivities} from '../enums'  

Summary

In this article, you learned about enum in Typescript. Thanks for reading!

#typescript #angular #Enum in Typescript

What is GEEK

Buddha Community

What is Enum in Typescript?

The Definitive Guide to TypeScript & Possibly The Best TypeScript Book

TypeScript Deep Dive

I've been looking at the issues that turn up commonly when people start using TypeScript. This is based on the lessons from Stack Overflow / DefinitelyTyped and general engagement with the TypeScript community. You can follow for updates and don't forget to ★ on GitHub 🌹

Reviews

  • Thanks for the wonderful book. Learned a lot from it. (link)
  • Its probably the Best TypeScript book out there. Good Job (link)
  • Love how precise and clear the examples and explanations are! (link)
  • For the low, low price of free, you get pages of pure awesomeness. Chock full of source code examples and clear, concise explanations, TypeScript Deep Dive will help you learn TypeScript development. (link)
  • Just a big thank you! Best TypeScript 2 detailed explanation! (link)
  • This gitbook got my project going pronto. Fluent easy read 5 stars. (link)
  • I recommend the online #typescript book by @basarat you'll love it.(link)
  • I've always found this by @basarat really helpful. (link)
  • We must highlight TypeScript Deep Dive, an open source book.(link)
  • Great online resource for learning. (link)
  • Thank you for putting this book together, and for all your hard work within the TypeScript community. (link)
  • TypeScript Deep Dive is one of the best technical texts I've read in a while. (link)
  • Thanks @basarat for the TypeScript Deep Dive Book. Help me a lot with my first TypeScript project. (link)
  • Thanks to @basarat for this great #typescript learning resource. (link)
  • Guyz excellent book on Typescript(@typescriptlang) by @basarat (link)
  • Leaning on the legendary @basarat's "TypeScript Deep Dive" book heavily at the moment (link)
  • numTimesPointedPeopleToBasaratsTypeScriptBook++; (link)
  • A book not only for typescript, a good one for deeper JavaScript knowledge as well. link
  • In my new job, we're using @typescriptlang, which I am new to. This is insanely helpful huge thanks, @basarat! link
  • Thank you for writing TypeScript Deep Dive. I have learned so much. link
  • Loving @basarat's @typescriptlang online book basarat.gitbooks.io/typescript/# loaded with great recipes! link
  • Microsoft doc is great already, but if want to "dig deeper" into TypeScript I find this book of great value link
  • Thanks, this is a great book 🤓🤓 link
  • Deep dive to typescript is awesome in so many levels. i find it very insightful. Thanks link
  • @basarat's intro to @typescriptlang is still one of the best going (if not THE best) link
  •  
  • This is sweet! So many #typescript goodies! link

Get Started

If you are here to read the book online get started.

Translations

Book is completely free so you can copy paste whatever you want without requiring permission. If you have a translation you want me to link here. Send a PR.

Other Options

You can also download one of the Epub, Mobi, or PDF formats from the actions tab by clicking on the latest build run. You will find the files in the artifacts section.

Special Thanks

All the amazing contributors 🌹

Share

Share URL: https://basarat.gitbook.io/typescript/

Author: Basarat
Source Code: https://github.com/basarat/typescript-book/ 
License: View license

#typescript #opensource 

Suparnar Taina

Suparnar Taina

1582263000

What is Enum in Typescript?

Introduction

In this article you will learn about Enum in Typescript in detail. This article will help beginners to understand the concept.

What is Enum?

  • The short form of enumeration is enum.
  • It is used as a type with some set of values called a named constant.
  • Inernally it holds numeric type values or in some cases we can create heterogeneous enums.
  • The enum keyword is used to define the enums.
  • We can create a distinct case so it makes it easy to document.
  • It forces us to use all possible values.
  • Access the enums using index or use dot operator after the enum name & named constant.
  • Initial value starts from 0 if we do not set any value.
  • Auto incremental is the best approach to use because we do not need to worry about the values.

Syntax

enum enumName{  
constant1, constant2, constant3...  
}  

Example

Consider  traffic signal lights as an example.

This is image title

We can access the elements using index or by constant name:

enum signalLights{  
   red, yellow, green  
}  
let result: string = signalLights[signalLights.red];  
console.log(result);  
console.log(signalLights[1]);  
let output: signalLights = (<any>signalLights)["yellow"];  
console.log(output);  

Output

red
yellow
1

Types of enums

Numeric enum

  • It is commonly used in all languages.
  • Initial value starts from 0 if we do not set any value.
  • Takes only numeric values.
  • enum keyword is used to declare the numeric type enum.
  • We can assign any value as per our requirements.
  • If our function returns any numeric value then we can use this function to initialize the constant.

Consider that in the below rainbowColors is enum & we have not initialized any constants, so it will starts with 0 value and the rest of the constants have auto increamemtal values.

**Example **

enum rainbowColors {  
    Red,  
    Orange,  
    Yellow,  
    Green,  
    Blue,  
    Indigo,  
    Violet,  
}  
console.log("color & index value is as follows");  
for (let item in rainbowColors) {  
    if (isNaN(Number(item))) {  
        console.log(item + " : " + < rainbowColors > rainbowColors[item]);  
    }  
}   

Output

color & index value is as follows:

Red : 0
Orange : 1
Yellow : 2
Green : 3
Blue : 4
Indigo : 5
Violet : 6

Consider the below example, rainbowColors is enum & the second element is initialized with value 1000. So it will be auto incremental to the  remaining constants. It will print on the console.

**Example **

enum rainbowColors {  
    Red,  
    Orange = 1000,  
    Yellow,  
    Green,  
    Blue,  
    Indigo,  
    Violet,  
}  
console.log("color & index value is as follows");  
for (let item in rainbowColors) {  
    if (isNaN(Number(item))) {  
        console.log(item + " : " + < rainbowColors > rainbowColors[item]);  
    }  
}   

Output

color & index value is as follows,

Red : 0
Orange : 1000
Yellow : 1001
Green : 1002
Blue : 1003
Indigo : 1004
Violet : 1005

Using function in enum

Consider the below example. We can use function in enum if we are returning the value from the function. It is used when the user needs to do any calculation. Suppose we need to calculate the total minutes like 1 hour = 60 minute, 2 hour = 120 minute, then it will create one function which will do a calcuation & return values to enum constant:

Example

function Totalminute(hr: number): any{  
return 60 * hr;  
}  
enum hours  
{  
One = Totalminute(1) ,  
Two = Totalminute(2),  
Three = Totalminute(4),  
}  
console.log(hours.One);  
console.log(hours.Two);  
console.log(hours.Three);  

Output

60
120
240

String enum

It is same as the numeric enums,  we are just passing string values/literals to our enum constant. enum keyword is used to declare the enums.

Consider the below example, our vehicle is taking different kinds of turns, and we will define the enum as:

Example

enum vehicleTurn {  
    Left = "Left",  
        Right = "Right",  
        UTurn = "UTurn"  
}  
console.log(vehicleTurn.Left);  
console.log(vehicleTurn.Right);  
console.log(vehicleTurn.UTurn);  
}   

Output

Left
Right
UTurn

Heterogeneous enums

Typescript allows us to create a mixed type of enums.

This means we can assign numeric & string type values to enum.

Consider the below example, circleInfo has heterogeneous enum values.

Example

enum circleInfo {  
    Area = "area of circle",  
        Pie = 3.112,  
        Radius = 20  
}  
let result = circleInfo.Pie * circleInfo.Radius * circleInfo.Radius;  
console.log(circleInfo.Area + " is :" + result); 

Output

area of circle is :1244.8

Point A - Function & interface using enum

Consider the below example, clothSize is enum which contains some constants. IClothSize is an interface which contains two properties, key & value, having string & number type respectively.

Function is taking enum as a parameter & will print the data on the console.

Example

enum clothSize {  
    small,  
    medium,  
    large  
}  
interface IClothSize {  
    key: string,  
        value: number  
}  
  
function getClothSize(size: clothSize): IClothSize {  
    switch (size) {  
        case clothSize.small:  
            return {  
                key: clothSize[clothSize.small], value: 10  
            };  
        case clothSize.medium:  
            return {  
                key: clothSize[clothSize.medium], value: 20  
            };  
        case clothSize.large:  
            return {  
                key: clothSize[clothSize.large], value: 30  
            };  
    }  
}  
console.log("cloth is " + getClothSize(clothSize.small).key + " & value is " + getClothSize(clothSize.small).value);  
console.log("cloth is " + getClothSize(clothSize.medium).key + " & value is " + getClothSize(clothSize.medium).value);  

Output

cloth is small & value is 10

cloth is medium & value is 20

Point B - const enum

  • Typescript allows us to declare const enum.
  • const keyword is used.
  • It has a inlined values.
  • We can access enum using enum[‘ConstantName’]

Example

const enum myColor {  
    Red = 10,  
        White = Red * 4,  
        Blue = White + 10,  
        Yellow,  
}  
console.log(myColor.Red)  
console.log(myColor.White)  
console.log(myColor.Blue)  
console.log(myColor['Yellow'])   

Output

10
40
50
51

We will not be able to access enum using index in const enum like myColor[0], it will give us an error.

Point C

ES6 allows us to use map enum keys.

Example

enum classes {  
    I,  
    II,  
    III,  
    IV,  
    V  
}  
const ClassNames = new Map < number,  
    string > ([  
        [classes.I, '100'],  
        [classes.II, '200'],  
        [classes.III, '300'],  
    ]);  
console.log(ClassNames);   

Output

Map(3) {0 => “100”, 1 => “200”, 2 => “300”}

We will modify the above example, we can use this into a classes as below.

Note

User can modify the code as per their requirement.

Example

enum classes {  
    I,  
    II,  
    III,  
    IV,  
    V  
}  
const ClassNames = new Map < number,  
    string > ([  
        [classes.I, '100'],  
        [classes.II, '200'],  
        [classes.III, '300'],  
    ]);  
class AllStandards {  
    public allNames: object;  
    constructor() {  
        this.allNames = ClassNames;  
    }  
}  
let obj: AllStandards = new AllStandards();  
console.log(obj.allNames);   

Output

Map(3) {0 => “100”, 1 => “200”, 2 => “300”}

Point D - export enum

  • typescript allows us to export the enum.
  • export keyword is used before the enum.
  • import is used to import that enum file.

We can declare the enum like this:

export enum sportActivities {Football, Cricket,Badminton, Tennis}  

To import the enum in .ts,  i.e.; typescript file looks like this:

import {sportActivities} from '../enums'  

Summary

In this article, you learned about enum in Typescript. Thanks for reading!

#typescript #angular #Enum in Typescript

Logan  Anderson

Logan Anderson

1640898060

How to Use Enums with TypeScript

In this tutorial, we will Learn how to use Enums with TypeScript.

#Enums #typescript 

TypeScript Enums or Objects?

TypeScript’s have Enums, which is a great language feature. However when you’re writing libraries and exposing functions that try and require Enums it can make for a bad user experience.

Instead you should use regular ol’ JavaScript objects - but super charged with TypeScript!

#typescript #enums

Noah  Sykes

Noah Sykes

1597206616

Using Enums in TypeScript

How to create enums in TypeScript with their benefits and drawbacks.

In this post, we will cover what TypeScript enums are and how to create them. We’ll also discover the drawbacks of enums and use cases where they work well.

What is an enum?

An enum is short for enumeration and is a type that represents named constants. If the meaning of the constant’s value is not apparent, it can make code easier to understand.

Consider the examples below:

if (status === 5) {
  // do something
}

if (status === JobStatus.Completed) {
  // do something
}

The second if statement uses an enum. It is arguably easier to understand than the first if statement.

#typescript #enums #developer