Skip to main content

flagsEnum

flagsEnum(): (target, key) => void

This decorator marks a property as a flags enumeration field. It enables bit-based flag functionality where enum values should be powers of 2 (1, 2, 4, 8...) so they can be combined and stored as a single number through bitwise operations. Each value represents a distinct bit in the resulting number that can be interpreted as true or false.

Sets {@link PropertyMeta.flagsEnum}.

Returns​

(target, key): void

Parameters​

target​

object

key​

string

Returns​

void