Typescript enum value as array parameter

Question

I will first of all state, that I am using TypeScript2.4, so I can use string ENUMs, ala

export enum PermissionScope {
BRAND = "brand",
IMAGE_MARKER = "image-marker",
COMPANY = "company",
PRODUCT = "product",
FINANCIALS = "financials"
}

I don't know how to do 2 things.

How can I type guard an enum, say

class A {
    let a : PermissionScope;
}

now when I try to instantiate this variable by

A.a = PermissionScope.BRAND

I get an error

Type 'string' is not assignable to type 'PermissionScope'.

This can kindof be fixed by

A.a = <PermissionScope> PermissionScope.BRAND

But I'm unsure if this is the right solution because as I understand, the underlying problem is that the variable is expected to be of a PermissionScope Enum Object type, not of a valid Enum value from PermissionScope.

How can I set the variable type so that it can only be one of the types from the enum?

The second question is.

What if I want to ask if a string is a valid Enum value, aka
```
var a = "brand"; //true
var b = "candy crush" //false
```

I don't think that the let inside your class is valid.. is that meant to be public a: PermissionScope; ? — Jye Lewis
– Jye Lewis, Commented Oct 25, 2017 at 21:18

Jye Lewis · Accepted Answer · 2017-10-25 21:28:05Z

For the first question, what you're trying to do shouldn't be a problem.
The 'let' inside your class may be causing your issues, I changed that to public and had no issues.
I also assume that your A.a example is meant to be an instance of A? your variable 'a' is an instance variable.

class A {
    public a : PermissionScope = PermissionScope.BRAND;
}
const instance = new A();

instance.a = PermissionScope.BRAND;

Answering your second question, the enum gets converted to an object under the hood. Which looks like this in raw js

var PermissionScope;
(function (PermissionScope) {
    PermissionScope["BRAND"] = "brand";
    PermissionScope["IMAGE_MARKER"] = "image-marker";
    PermissionScope["COMPANY"] = "company";
    PermissionScope["PRODUCT"] = "product";
    PermissionScope["FINANCIALS"] = "financials";
})(PermissionScope = exports.PermissionScope || (exports.PermissionScope = {}));

So you can see if the static part of your enum is valid using 'in'

console.log('BRAND' in PermissionScope); //true
console.log('IMAGE_MARKER' in PermissionScope); //true
console.log('ASDF' in PermissionScope); //false

If you want to check the value part of the enum you would have to iterate through the object values and check that

function isValidEnumValue(enumType: any, value: string) {
    //NOTE: Object.values is only available in ES7 (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_objects/Object/values)
    return Object.values(enumType).indexOf(value) !== -1;
}

console.log(isValidEnumValue(PermissionScope, 'brand')); //true
console.log(isValidEnumValue(PermissionScope, 'asdf')); //false

Collectives™ on Stack Overflow

Typescript enum value as array parameter

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related