An interface representing the eligibility status of a flag, and optional variables associated with the flag.
Members
_meta :object|undefined
The name of the feature flag.
Properties:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
name |
string
|
|||||||
device |
object
|
|||||||
| Name | Type | Description |
|---|---|---|
channelId |
string
|
|
contactId |
string
|
contextunknown
Type:
-
object|undefined
data :unknown|null
A data payload associated with the flag, if any. Will be null if no data
is associated with the flag, or if the flag does not exist.
Type:
-
unknown|null
eligible :boolean
A boolean representing flag eligibility; will be true if the current
contact is eligible for the flag.
Type:
-
boolean
exists :boolean
A boolean representing if the flag exists or not. For ease of use and
deployment, asking for a flag by any name will return a FeatureFlag
interface, even if the flag was not found to exist. However this property
may be checked to determine if the flag was actually resolved to a known
flag name.
Type:
-
boolean