model

Documentation

Index

• Constants
• Variables
• func GetErrorMessage(code string) string
• type EvaluationReason
• type Evaluators
• type Flag
• type StateChangeNotification
• type StateChangeNotificationType

Constants

const (
	FlagNotFoundErrorCode = "FLAG_NOT_FOUND"
	ParseErrorCode        = "PARSE_ERROR"
	TypeMismatchErrorCode = "TYPE_MISMATCH"
	GeneralErrorCode      = "GENERAL"
	FlagDisabledErrorCode = "FLAG_DISABLED"
	InvalidContextCode    = "INVALID_CONTEXT"
)

const (
	TargetingMatchReason = "TARGETING_MATCH"
	SplitReason          = "SPLIT"
	DisabledReason       = "DISABLED"
	DefaultReason        = "DEFAULT"
	UnknownReason        = "UNKNOWN"
	ErrorReason          = "ERROR"
	StaticReason         = "STATIC"
)

Variables

var ReadableErrorMessage = map[string]string{
	FlagNotFoundErrorCode: "Flag not found",
	ParseErrorCode:        "Error parsing input or configuration",
	TypeMismatchErrorCode: "Type mismatch error",
	GeneralErrorCode:      "General error",
	FlagDisabledErrorCode: "Flag is disabled",
	InvalidContextCode:    "Invalid context provided",
}

Functions

func GetErrorMessage

func GetErrorMessage(code string) string

Types

type EvaluationReason

type EvaluationReason string

type Evaluators

type Evaluators struct {
	Evaluators map[string]json.RawMessage `json:"$evaluators"`
}

type Flag

type Flag struct {
	State          string                 `json:"state"`
	DefaultVariant string                 `json:"defaultVariant"`
	Variants       map[string]any         `json:"variants"`
	Targeting      json.RawMessage        `json:"targeting,omitempty"`
	Source         string                 `json:"source"`
	Selector       string                 `json:"selector"`
	Metadata       map[string]interface{} `json:"metadata,omitempty"`
}

type StateChangeNotification

type StateChangeNotification struct {
	Type    StateChangeNotificationType `json:"type"`
	Source  string                      `json:"source"`
	FlagKey string                      `json:"flagKey"`
}

type StateChangeNotificationType

type StateChangeNotificationType string

const (
	NotificationDelete StateChangeNotificationType = "delete"
	NotificationCreate StateChangeNotificationType = "write"
	NotificationUpdate StateChangeNotificationType = "update"
)