View Source cfclient (cfclient v0.5.0-beta.1)

Public interface for client.

Link to this section Summary

Link to this section Types

-type config() :: map().
-type target() ::
    #{identifier := binary(),
      name := binary(),
      anonymous => boolean(),
      attributes := #{atom() := binary() | atom() | list()} | null}.

Link to this section Functions

Link to this function

bool_variation(FlagKey, Target, Default)

View Source
-spec bool_variation(binary() | string(), target(), boolean()) -> boolean().
Evaluate variation which returns a boolean.
Link to this function

bool_variation(Config, FlagKey, Target, Default)

View Source
-spec bool_variation(atom() | config(), binary() | string(), target(), boolean()) -> boolean().
Link to this function

json_variation(FlagKey, Target, Default)

View Source
-spec json_variation(binary() | string(), target(), map()) -> map().
Evaluate variation which returns a JSON object.
Link to this function

json_variation(Config, FlagKey, Target, Default)

View Source
-spec json_variation(atom() | config(), binary() | list(), target(), map()) -> map().
Link to this function

number_variation(FlagKey, Target, Default)

View Source
-spec number_variation(binary() | list(), target(), number()) -> number().
Evaluate variation which returns a number.
Link to this function

number_variation(Config, FlagKey, Target, Default)

View Source
-spec number_variation(atom() | config(), binary() | list(), target(), number()) -> number().
Link to this function

string_variation(FlagKey, Target, Default)

View Source
-spec string_variation(binary() | string(), target(), binary()) -> binary().
Evaluate variation which returns a string.
Link to this function

string_variation(Config, FlagKey, Target, Default)

View Source
-spec string_variation(atom() | config(), binary() | list(), target(), binary()) -> binary().