String Feature Flag

A string feature flag produces string evaluation values and is denoted by a type value of "string".

String feature flags have the shared feature flag properties as described in Feature Flag and has the additional properties on this page.

The schema for a string feature flag looks roughly like this:

Schema

{
  "id": "...",
  "name": "...",
  "description": "...",
  
  // Type specific attributes
  "type": "string",
  "targeting": {
    "enabled": true,
    "rules": []
  },
  "defaultValue": ""
}

Attributes

type

• Type: "string"
• Required

Designated the feature flag object as a string feature flag.

targeting

• Type: { enabled: boolean, rules: StringFeatureFlagRule[] }
• Required

An object describing targeting rules which can be turned on or off completely or individually.

enabled

• Type: boolean
• Required

If true, the rules are checked during the feature flag evaluation.

If false, all rules are ignored and the defaultValue is used as the evaluation value.

rules

• Type: Array of StringFeatureFlagRule
• Required

An array of zero to N-many rules that can have conditions and specified output values in case the conditions are met.

The order of the rules determines the evaluation order. Rules are evaluated from front to end. If a rule's conditions are met, it's valuesOnMatch (check out rule details) are returned as the evaluation value.

If no rules' conditions are met, the defaultValue of the feature flag is returned as the evaluation value.

Check out String Feature Flag Rule for more details.

defaultValue

• Type: string
• Required

The default value to be returned as the feature flag's evaluation value if targeting.enabled is set to false.