lmfinney / ts-enums Goto Github PK

Unless I'm mistaken, it looks like you are relying on getOwnPropertyNames to determine the order of the enum values from which you set the ordinal. I'm pretty sure the order of that array is not guaranteed by the spec and it's possible to get different orderings on different platforms. This could be disastrous if you were using the ordinal on both a web-browser and a server and expecting them to match.

I didn't dig into the code, but the original Enumify library took the list of value names as an array in the initEnum function. Perhaps you should do something similar and require the programmer to pass in the values of the enum as an array in the order in which they should be defined. Then the ordinal only changes if the programmer changes it.

At a minimum, you might want to note in your documentation that the ordinal isn't guaranteed between platforms (or who knows, maybe even between separate invocations on the same platform).

@Enum("text")
export class PeriodUnit extends EnumType<PeriodUnit>() {

    static readonly DAY = new PeriodUnit('d');

    private constructor(
        readonly text: string,
    ) {
        super()
    }
}

export function EnumProp<T extends IStaticEnum<T> & { text: string }>(
    enumCls: T,
    options?: PropOptions
) {
    return (target, propertyKey) => {
        Prop({
            ...(options as object),
            type: String,
            set: (v: T) => v.text,
            get: (v: string) => enumCls.valueOf(v)
        })(target, propertyKey);
    }
}

@Schema()
export class Period {

    @Prop({ required: true })
    value: number

    @EnumProp(PeriodUnit,{
        required: true
    })
    unit: PeriodUnit
}

Argument of type 'typeof PeriodUnit' is not assignable to parameter of type 'IStaticEnum<typeof PeriodUnit> & { text: string; }'

I'd like to be able to use just the types from this library but they're not available as typings via @types. Could you work with https://github.com/DefinitelyTyped/DefinitelyTyped to expose the typings via @types/ts-enums?