Rulestead.Result (rulestead v0.1.3)

Copy Markdown View Source

Stable Phase 3 evaluation result.

Summary

Types

debug_trace()
reason()
t()

Functions

new(result)
normalize(result)

Types

debug_trace()

@type debug_trace() :: map() | nil

reason()

@type reason() :: :rule_match | :default | :targeting_key_missing | :flag_off | :error

t()

@type t() :: %Rulestead.Result{
  cache_age_ms: integer() | nil,
  debug_trace: debug_trace(),
  enabled?: boolean(),
  flag_key: String.t() | nil,
  flag_version: integer() | nil,
  matched_rule: String.t() | nil,
  reason: reason(),
  value: term(),
  variant: String.t() | nil
}

Functions

new(result)

@spec new(t() | keyword() | map()) :: t()

normalize(result)

@spec normalize(t() | keyword() | map()) :: t()