Class-transformer: Transforming Enum

[karthikastra]

Hi,

Is it possible to transform ENUM to String and String to ENUM?

thanks
Karthik

[pleerock]

afaik string enums are not supported by Typescript

[karthikastra]

What i meant by is if you have a enum like below

enum PlanType {
Basic,
Premium
}

class Plan {
name: string;
type: PlanType;
}

When we convert the following json { name: "Basic Plan", type: "Basic" } to Plan object, the type property is set as "Basic" string instead of PlanType.Basic enum.

Is it possible to convert the String representation of enum to enum?

[pleerock]

I don't think its possible because of Typescript specifics. Basic in PlanType is not a string representation, so it cannot be mapped to a string

[karthikastra]

Finally found a way to do this

enum PlanType {
    Basic = 1,
    Premium = 2,
    Advanced = 3
}

class Plan {

    @Exclude()
    planType: PlanType;

    get type() : string {
        return PlanType[this.planType];
    }

    set type(typeName: string) {
        this.planType = PlanType[typeName];
    }
}

let plan: Plan = new Plan();

plan.planType = PlanType.Basic;
console.log(plan.type); // Basic
console.log(plan.planType); // 1

plan.type = "Premium";
console.log(plan.type); // Premium
console.log(plan.planType); // 2


plan.planType = 3;
console.log(plan.type); // Advanced
console.log(plan.planType); // 3

[gliluaume]

I suggest the use of a transformation decorator @Transform(myEnumToString). For example you will have in your enum type module :

export enum PlanType {
    Basic = 1,
    Premium = 2,
    Advanced = 3
}

export function planTypeToString(type: PlanType): string {
    return PlanType[type];
}

your Plan class would look cleaner and your planType property would keep its type PlanType:

import { PlanType, planTypeToString} from './PlanType';

class Plan {
    @Exclude()
    @Transform(planTypeToString)
    planType: PlanType;
}

[iturn]

Short option:

enum Status {
 pending = 2,
  inactive = 3,
  active = 4
}

@Transform(status => Status[status])
@Column({ name: 'Status' })
status: Status

[github-actions[bot]]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.