Flag evaluation reasons

The VariationDetail methods, such as BoolVariationDetail, work the same as Variation, but also provide additional "reason" information about how a flag value was calculated. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

var config = Configuration
    .Builder("mobile-key-123abc", ConfigurationBuilder.AutoEnvAttributes.Enabled)
    .EvaluationReasons(true)
    .Build();
LdClient client = LdClient.Init(config, context);
EvaluationDetail<bool> detail =
    client.BoolVariationDetail("bool-flag-key-123abc", false);
    // or StringVariationDetail for a string-valued flag, and so on.
bool value = detail.Value;
int? index = detail.VariationIndex;
EvaluationReason reason = detail.Reason;
COPY

To learn more about the VariationDetail methods, read EvaluationDetail and BoolVariationDetail. To learn more about the configuration option, read EvaluationReasons.

The variationDetail methods, such as boolVariationDetail, work the same as variation. They also provide additional "reason" information about how a flag value was calculated, such as if the context matched a specific rule. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

LDConfig ldConfig = new LDConfig.Builder(AutoEnvAttributes.Enabled)
  .mobileKey("mobile-key-123abc")
  .evaluationReasons(true)
  .build();
LDClient client = LDClient.init(this.getApplication(), ldConfig, context, secondsToBlock);
EvaluationDetail<Boolean> detail =
  client.boolVariationDetail("flag-key-123abc", false);
  // or stringVariationDetail for a string-valued flag, etc.
boolean value = detail.getValue();
Integer index = detail.getVariationIndex();
EvaluationReason reason = detail.getReason();
COPY

To learn more about the variationDetail methods, read EvaluationDetail and getVariationIndex. To learn more about the configuration option, read evaluationReasons.

Here is an example of how to access the details of a reason object:

void printReason(EvaluationReason reason) {
  switch (reason.getKind()) {
    case OFF:
      Timber.d("it's off");
      break;
    case FALLTHROUGH:
      Timber.d("fell through");
      break;
    case TARGET_MATCH:
      Timber.d("targeted");
      break;
    case RULE_MATCH:
      EvaluationReason.RuleMatch rm =
        (EvaluationReason.RuleMatch)reason;
      Timber.d("matched rule %d/%s",
               rm.getRuleIndex(),
               rm.getRuleId());
      break;
    case PREREQUISITE_FAILED:
      EvaluationReason.PrerequisiteFailed pf =
        (EvaluationReason.PrerequisiteFailed)reason;
      Timber.d("prereq failed: %s", pf.getPrerequisiteKey());
      break;
    case ERROR:
      EvaluationReason.Error e = (EvaluationReason.Error)reason;
      Timber.d("error: %s", e.getErrorKind());
  }
  // or, if all you want is a simple descriptive string:
  Timber.d(reason.toString());
}
COPY

To learn more, read EvaluationReason.

You can request and then programmatically inspect the reason for a particular feature flag evaluation.

The detail.Reason() response is described in Evaluation reasons.

Here is an example:

auto detail = client.BoolVariationDetail("flag-key-123abc", false);
if (detail.Value()) {
   std::cout << "Value was true!" << std::endl;
} else {
   // it was false, let's find out why.
   if (auto reason = detail.Reason()) {
      // reason might not be present, so we have to check
      std::cout << "Value was false because of " << reason << std::endl;
   } else {
      std::cout << "No reason provided to explain why flag was false!" << std::endl;
   }
}
COPY

To learn more, read EvaluationDetail and BoolVariationDetail.

The variationDetail methods work the same as variation. They also provide additional "reason" information about how a flag value was calculated. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

const { value, variationIndex, reason } = client.variationDetail('flag-key-123abc', false);
COPY

To learn more about the variationDetail methods, read LDEvaluationDetail and variationDetail. To learn more about the configuration option, read LDEvaluationReason.

The variationDetail methods, such as boolVariationDetail, work the same as variation. They also provide additional "reason" information about how a flag value was calculated. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

To enable this functionality, set the evaluationReasons configuration option to true when you initialize the client.

Here is an example:

final config = LDConfig(
  CredentialSource.fromEnvironment,
  AutoEnvAttributes.enabled,
  dataSourceConfig: DataSourceConfig(
    evaluationReasons: true
  ),
);
// initialize client and context
LDEvaluationDetail<bool> detail =
  client.boolVariationDetail('flag-key-123abc', false);
  // or stringVariationDetail for a string-valued flag, and so on.
bool value = detail.value;
int index = detail.variationIndex;
LDEvaluationReason reason = detail.reason;
COPY

To learn more about the variationDetail methods, read LDEvaluationDetail and boolVariationDetail. To learn more about the configuration option, read evaluationReasons.

Here is an example of how to access the details of a reason object:

void printReason(LDEvaluationReason reason) {
  switch (reason.kind) {
    case LDKind.OFF:
      print("it's off");
      break;
    case LDKind.FALLTHROUGH:
      print('fell through');
      break;
    case LDKind.TARGET_MATCH:
      print('targeted');
      break;
    case LDKind.RULE_MATCH:
      print('matched rule: ${reason.ruleIndex} ${reason.ruleId}');
      break;
    case LDKind.PREREQUISITE_FAILED:
      print('prereq failed: ${reason.prerequisiteKey}');
      break;
    case LDKind.ERROR:
      print('error: ${reason.errorKind}');
      break;
    default: // LDKind.UNKNOWN
      print('unknown service kind');
  }
}
COPY

To learn more, read LDEvaluationDetail.

The variationDetail methods, such as boolVariationDetail, work the same as the variation methods. They also provide additional "reason" information about how a flag value was calculated, such as if the user matched a specific rule. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

ldConfig.evaluationReasons = true
LDClient.start(config: ldConfig, context: context)
let detail = client.boolVariationDetail(forKey: "flag-key-123abc", defaultValue: false);
let value: Bool = detail.value
let variationIndex: Int? = detail.variationIndex
let reason: [String: LDValue]? = detail.reason
COPY

To learn more about the variationDetail methods, read LDEvaluationDetail and boolVariationDetail. To learn more about the configuration option, read LDConfig.

The variationDetail method lets you evaluate a feature flag with the same parameters you would for variation. With variationDetail, you receive more information about how the value was calculated.

The variation detail returns in an object containing both the result value and a "reason" object which tells you more information about the flag evaluation. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. It also indicates if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

const options = { evaluationReasons: true };
const client = LDClient.initialize('client-side-id-123abc', context, options);
const detail = client.variationDetail('flag-key-123abc', false);
const value = detail.value;
const index = detail.variationIndex;
const reason = detail.reason;
COPY

To learn more about the variationDetail methods, read LDEvaluationDetail and variationDetail. To learn more about the configuration option, read evaluationReasons.

The variationDetail method lets you evaluate a feature flag with the same parameters you would for variation. With variationDetail, you receive more information about how the value was calculated.

The variation detail returns in an object that contains both the result value and a "reason" object which tells you more information about the flag evaluation. For example, you can find out if the user was individually targeted for the flag or was matched by one of the flag's rules. It also indicates if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

const options = { evaluationReasons: true };
const client = LDClient.initialize('client-side-id-123abc', user, options);
const detail = client.variationDetail('flag-key-123abc', false);
const value = detail.value;
const index = detail.variationIndex;
const reason = detail.reason;
COPY

To learn more about the variationDetail method, read LDEvaluationDetail and variationDetail. To learn more about the configuration option, read evaluationReasons.

The variationDetail methods work the same way as the variation methods, and also provide additional information about how a flag value was calculated. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export. To view this reason information, set the withReasons configuration option to true.

In React Native, there is a variation detail method for each type, such as boolVariationDetail or stringVariationDetail. In the React Native SDK version 10, there is also a hook for each type, such as useBoolVariationDetail or useStringVariationDetail.

Here is an example:

const { reason, value, variationIndex } = useBoolVariationDetail('flag-key-123abc', false);
COPY

To learn more about the variationDetail methods, read LDEvaluationDetail, useBoolVariationDetail and boolVariationDetail.

To learn more about the withReasons configuration option, read LDOptions.

The SDK also includes an untyped method to determine the variation of a feature flag and provide information about how the flag value was calculated. To learn more, read variationDetail. We recommend using the strongly typed variation methods, such as boolVariationDetail, which perform type checks and handle type errors.

For each variation type there is also an associated version that returns the reason a particular value was returned.

Here is an example:

config.setUseEvaluationReasons(true)
details = launchDarkly.intVariationDetail("flag-key-123abc", 123)
COPY

These variation methods return an object containing the keys value, reason, and variationIndex. The value field is the result of the evaluation. The reason field is an object that explains why the result happened, for example details about a rule match. The reason object will always contain a kind field. Lastly the variationIndex field contains the ID of the particular value returned. This field may be null.

The VariationDetail methods, such as BoolVariationDetail, work the same as the Variation methods, but also provide additional "reason" information about how a flag value was calculated. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

EvaluationDetail<bool> detail =
    client.BoolVariationDetail("flag-key-123abc", myContext, false);
    // or StringVariationDetail for a string-valued flag, etc.
bool value = detail.Value;
int? index = detail.VariationIndex;
EvaluationReason reason = detail.Reason;
COPY

To learn more, read EvaluationDetail, BoolVariationDetail.

Here is an example of how to access the details of a reason object:

void PrintReason(EvaluationReason reason)
{
  switch (reason.Kind)
  {
    case EvaluationReasonKind.OFF:
      Console.WriteLine("it's off");
      break;
    case EvaluationReasonKind.FALLTHROUGH:
      Console.WriteLine("fell through");
      break;
    case EvaluationReasonKind.TARGET_MATCH:
      Console.WriteLine("targeted");
      break;
    case EvaluationReasonKind.RULE_MATCH:
      var rm = reason as EvaluationReason.RuleMatch;
      Console.WriteLine("matched rule " + rm.RuleIndex + "/" + rm.RuleID);
      break;
    case EvaluationReasonKind.PREREQUISITE_FAILED:
      var pf = reason as EvaluationReason.PrerequisiteFailed;
      Console.WriteLine("prereq failed: " + pf.PrerequisiteKey);
      break;
    case EvaluationReasonKind.ERROR:
      var e = reason as EvaluationReason.Error;
      Console.WriteLine("error: " + e.ErrorKind);
      break;
  }
  // or, if all you want is a simple descriptive string:
  System.out.println(reason.ToString());
}
COPY

To learn more, read EvaluationReason.

By passing an LDClient.EvaluationDetail object to a variation call you can programmatically inspect the reason for a particular evaluation.

Here is an example:

LDClient.EvaluationDetail details = new LDClient.EvaluationDetail();
Boolean value = client.boolVariation(user, 'your.feature.key', false, details);
/* inspect details here */
if (details.getReason().getKind() == EvaluationReason.Kind.OFF) {
    /* ... */
}
COPY

You can request and then programmatically inspect the reason for a particular feature flag evaluation.

The detail.Reason() response is described in Evaluation reasons.

Here is an example:

auto detail = client.BoolVariationDetail(context, "flag-key-123abc", false);
if (detail.Value()) {
   std::cout << "Value was true!" << std::endl;
} else {
   // it was false, let's find out why
   if (auto reason = detail.Reason()) {
      // reason might not be present, so we have to check
      std::cout << "Value was false because of " << reason << std::endl;
   } else {
      std::cout << "No reason provided to explain why flag was false!" << std::endl;
   }
}
COPY

To learn more, read EvaluationDetail.

The variation_detail function is similar to the variation function, but also returns an explanation of the evaluation that you can inspect programmatically.

Here is an example:

Flag = ldclient:variation_detail(<<"flag-key-123abc">>, #{key => <<"context-key-123abc">>}, false)
COPY

The VariationDetail methods, such as BoolVariationDetail, work the same as Variation, but also provide additional "reason" information about how a flag value was calculated. For example, you can find out if the context was individually targeted by the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

value, detail, err := client.BoolVariationDetail("flag-key-123abc", context, false)
// or StringVariationDetail for a string-valued flag, etc.
index := detail.VariationIndex
reason := detail.Reason
COPY

To learn more, read EvaluationDetail and BoolVariationDetail.

Here is an example of how to access the details of a reason object:

import (
    "github.com/launchdarkly/go-sdk-common/v3/ldreason"
)
func PrintReason(reason ldreason.EvaluationReason) {
  switch reason.GetKind() {
  case ldreason.EvalReasonOff:
    fmt.Println("it's off")
  case ldreason.EvalReasonFallthrough:
    fmt.Println("fell through")
  case ldreason.EvalReasonTargetMatch:
    fmt.Println("targeted")
  case ldreason.EvalReasonRuleMatch:
    fmt.Printf("matched rule %d/%s\n", r.GetRuleIndex(), r.GetRuleID())
  case ldreason.EvalReasonPrerequisiteFailed:
    fmt.Printf("prereq failed: %s\n", r.GetPrerequisiteKey())
  case ldreason.EvalReasonError:
    fmt.Printf("error: %s\n", r.GetErrorKind())
  }
  // or, if all you want is a simple descriptive string:
  fmt.Println(reason)
}
COPY

To learn more, read EvaluationReason.

If you are using OpenTelemetry, then instead of using the VariationDetail method for each type, you must use the VariationDetailCtx method for each type. For example, use BoolVariationDetailCtx rather than BoolVariationDetail. The methods are the same except that the VariationDetailCtx methods also require a Go context parameter. This Go context is used in the hook implementation that provides OpenTelemetry support. To learn more, read OpenTelemetry.

The variationDetail functions are similar to the variation functions, but they also return an explanation of the evaluation that is programmatically inspectable.

Here is an example:

details :: IO (EvaluationDetail Bool)
details = boolVariationDetail client "flag-key-123abc" context False
COPY

To learn more, read EvaluationDetail and boolVariationDetail.

The variationDetail methods, such as boolVariationDetail, work the same as variation, but also provide additional "reason" information about how a flag value was calculated. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

import com.launchdarkly.sdk.*;
EvaluationDetail<Boolean> detail =
  client.boolVariationDetail("flag-key-123abc", context, false);
  // or stringVariationDetail for a string-valued flag, and so on.
boolean value = detail.getValue();
int index = detail.getVariationIndex();       // will be < 0 if evaluation failed
EvaluationReason reason = detail.getReason();
COPY

To learn more, read EvaluationDetail and boolVariationDetail.

Here is an example of how to access the details of a reason object:

void printReason(EvaluationReason reason) {
  switch (reason.getKind()) {
    case OFF:
      System.out.println("it's off");
      break;
    case FALLTHROUGH:
      System.out.println("fell through");
      break;
    case TARGET_MATCH:
      System.out.println("targeted");
      break;
    case RULE_MATCH:
      EvaluationReason.RuleMatch rm = (EvaluationReason.RuleMatch)reason;
      System.out.println("matched rule " + rm.getRuleIndex()
        + "/" + rm.getRuleId());
      break;
    case PREREQUISITE_FAILED:
      EvaluationReason.PrerequisiteFailed pf =
        (EvaluationReason.PrerequisiteFailed)reason;
      System.out.println("prereq failed: " + pf.getPrerequisiteKey());
      break;
    case ERROR:
      EvaluationReason.Error e = (EvaluationReason.Error)reason;
      System.out.println("error: " + e.getErrorKind());
  }
  // or, if all you want is a simple descriptive string:
  System.out.println(reason.toString());
}
COPY

To learn more, read EvaluationReason.

By using the *VariationDetail family of variation calls you can programmatically inspect the reason for a particular evaluation:

local details = client:boolVariationDetail(client, context, "flag-key-123abc", false);
-- inspect details here
if details.reason == "FLAG_NOT_FOUND" then
end
COPY

To learn more, read boolVariationDetail.

The variationDetail method lets you evaluate a feature flag (using the same parameters as you would for variation) and receive more information about how the value was calculated.

The variation detail is returned in an object that contains both the result value and a "reason" object which will tell you, for instance, if the context was individually targeted for the flag or was matched by one of the flag's rules. It will also indicate if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

var detail = client.variationDetail('flag-key-123abc', context, false);
var value = detail.value;
var index = detail.variationIndex;
var reason = detail.reason;
COPY

To learn more, read LDEvaluationDetail and variationDetail.

Here is an example of how to access the details of a reason object:

function printReason(reason) {
  switch(reason.kind) {
    case "OFF":
      console.log("it's off");
      break;
    case "FALLTHROUGH":
      console.log("fell through");
      break;
    case "TARGET_MATCH":
      console.log("targeted");
      break;
    case "RULE_MATCH":
      console.log("matched rule " + reason.ruleIndex + ", "  + reason.ruleId);
      break;
    case "PREREQUISITE_FAILED":
      console.log("prereq failed: " + reason.prerequisiteKey);
      break;
    case "ERROR":
      console.log("error: " + reason.errorKind);
      break;
  }
}
COPY

To learn more, read LDEvaluationReason.

The variationDetail method lets you evaluate a feature flag (using the same parameters as you would for variation) and receive more information about how the value was calculated.

The variation detail is returned in an object that contains both the result value and a "reason" object which will tell you, for example, if the context was individually targeted for the flag or was matched by one of the flag's rules. It will also indicate if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

$detail = $client->variationDetail("flag-key-123abc", $myContext, false);
$value = $detail->getValue();
$index = $detail->getVariationIndex();
$reason = $detail->getReason();
COPY

To learn more, read EvaluationDetail and variationDetail.

Here is an example of how to access the details of a reason object:

function printReason($reason) {
  switch ($reason->getKind()) {
    case EvaluationReason::OFF:
      echo("it's off");
      break;
    case EvaluationReason::FALLTHROUGH:
      echo("fell through");
      break;
    case EvaluationReason::TARGET_MATCH:
      echo("targeted");
      break;
    case EvaluationReason::RULE_MATCH:
      echo("matched rule " . $reason->getRuleIndex() .
        "/" . $reason->getRuleId());
      break;
    case EvaluationReason::PREREQUISITE_FAILED:
      echo("prereq failed: " . $reason->getPrerequisiteKey());
      break;
    case EvaluationReason::ERROR:
      echo("error: " . $reason->getErrorKind());
      break;
  }
  // or, if all you want is a simple descriptive string:
  echo $reason;
}
COPY

To learn more, read EvaluationReason.

The variation_detail method lets you evaluate a feature flag with the same parameters as you would for variation. You can use this method to receive more information about how the value was calculated.

The variation detail is returned in an object that contains both the result value and a "reason" object which will tell you, for instance, if the context was individually targeted for the flag or was matched by one of the flag's rules. It will also indicate if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

detail = client.variation_detail("flag-key-123abc", my_context, False)
value = detail.value
index = detail.variation_index
reason = detail.reason
COPY

To learn more, read EvaluationDetail and variation_detail.

Here is an example of how to access the details of a reason object:

def print_reason(reason):
  kind = reason["kind"]
  if kind == "OFF":
    print "it's off"
  elif kind == "FALLTHROUGH":
    print "fell through"
  elif kind == "TARGET_MATCH":
    print "targeted"
  elif kind == "RULE_MATCH":
    print "matched rule %d/%s" % (reason["ruleIndex"], reason["ruleId"])
  elif kind == "PREREQUISITE_FAILED":
    print "prereq failed: %s" % reason["prerequisiteKey"]
  elif kind == "ERROR":
    print "error: %s" % reason["errorKind"]
COPY

To learn more, read EvaluationDetail.reason.

The variation_detail method lets you evaluate a feature flag (using the same parameters as you would for variation) and receive more information about how the value was calculated.

The variation detail is returned in an object that contains both the result value and a "reason" object which will tell you, for instance, if the context was individually targeted for the flag or was matched by one of the flag's rules. It will also indicate if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

detail = client.variation_detail("flag-key-123abc", my_context, false)
value = detail.value
index = detail.variation_index
reason = detail.reason
COPY

To learn more, read EvaluationDetail and variation_detail.

Here is an example of how to access the details of a reason object:

def print_reason(reason)
  case reason[:kind]
  when "OFF"
    puts "it's off"
  when "FALLTHROUGH"
    puts "fell through"
  when "TARGET_MATCH"
    puts "targeted"
  when "RULE_MATCH"
    puts "matched rule #{reason[:ruleIndex]}/#{reason[:ruleId]}"
  when "PREREQUISITE_FAILED"
    puts "prereq failed: #{reason[:prerequisiteKey]}"
  when "ERROR"
    puts "error: #{reason[:errorKind]}"
  end
end
COPY

To learn more, read EvaluationDetail.reason.

The variation_detail methods (for example, bool_variation_detail) let you evaluate a feature flag, using the same parameters as you would for variation, and receive more information about how the flag value was calculated. For example, you can find out if the context was individually targeted for the flag or was matched by one of the flag's rules. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

let detail = client.bool_variation_detail(&context, "flag-key-123abc", false);
let value = detail.value;
let index = detail.variation_index;
let reason = detail.reason;
COPY

To learn more, read variation_detail and bool_variation_detail.

Here is an example of how to access the details of a reason object:

fn print_reason(reason: Reason) {
    match reason {
        Reason::Off => println!("it's off"),
        Reason::Fallthrough { .. } => println!("fell through"),
        Reason::TargetMatch => println!("targeted"),
        Reason::RuleMatch {
            rule_index,
            rule_id,
            ..
        } => println!("matched rule {}/{}", rule_index, rule_id),
        Reason::PrerequisiteFailed { prerequisite_key } => {
            println!("prereq failed: {}", prerequisite_key)
        }
        Reason::Error { error } => println!("error: {:?}", error),
    };
}
COPY

To learn more, read Reason.

The variationDetail method lets you evaluate a feature flag using the same parameters as you would for variation and receive more information about how the value was calculated.

The SDK returns the variation detail in an object that contains both the result value and a reason object. These tell you more information. For example, they can tell you if the flag individually targeted the context, or if the context matched one of the flag's rules. It will also indicate if the flag returned the default value due to an error. You can examine the reason data programmatically.

Here is an example:

const { value, variationIndex, reason } = await client.variationDetail(flagKey, context, false);
COPY

To learn more, read variationDetail, LDEvaluationDetail and LDEvaluationReason.

The LDClient also provides typed variation methods for type-safe usage in TypeScript: boolVariationDetail, stringVariationDetail, numberVariationDetail, jsonVariationDetail.

The variationDetail method lets you evaluate a feature flag using the same parameters as you would for variation and receive more information about how the value was calculated.

The SDK returns the variation detail in an object that contains both the result value and a "reason" object. These tell you, for instance, if the flag individually targeted the context or if the context matched one of the flag's rules. It will also indicate if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

const { value, variationIndex, reason } = await client.variationDetail(flagKey, context, false);
COPY

To learn more, read variationDetail, LDEvaluationDetail and LDEvaluationReason.

The LDClient also provides typed variation methods for type-safe usage in TypeScript: boolVariationDetail, stringVariationDetail, numberVariationDetail, jsonVariationDetail.

The variationDetail method lets you evaluate a feature flag using the same parameters as you would for variation and receive more information about how the value was calculated.

The SDK returns the variation detail in an object that contains both the result value and a "reason" object. These tell you more information. For example, they can tell you if the flag individually targeted the context, or if the context matched one of the flag's rules. It will also indicate if the flag returned the default value due to an error. You can examine the "reason" data programmatically, or, if you capture detailed analytics events for flags, view it with Data Export.

Here is an example:

const { value, variationIndex, reason } = await client.variationDetail(flagKey, context, false);
COPY

To learn more, read variationDetail, LDEvaluationDetail and LDEvaluationReason.

The LDClient also provides typed variation methods for type-safe usage in TypeScript: boolVariationDetail, stringVariationDetail, numberVariationDetail, jsonVariationDetail.