VexillaClientElixir (vexilla_client_elixir v0.0.1)

Documentation for VexillaClientElixir.

Link to this section Summary

Functions

Create a client with a base url and environment name

Fetch the flags and parse, returning the appropriate flags for the environment

Checks if the flag allows this feature to be used

Checks if the flag allows this feature to be used

Link to this section Functions

Link to this function

create_config(base_url, environment)

Create a client with a base url and environment name

Examples

iex> VexillaClientElixir.create_config("https://somewhere-on-the-internet", "staging") %{

base_url: "https://somewhere-on-the-internet",
environment: "staging"

}

Link to this function

get_flags(config, fileName)

Fetch the flags and parse, returning the appropriate flags for the environment

Examples

iex> VexillaClientElixir.get_flags(%{base_url: "https://streamparrot-feature-flags.s3.amazonaws.com",environment: "staging"}, "features") %{

"untagged" => %{
  "billing" => %{
    "type" => "toggle",
    "value" => false
  }
},
"features" => %{
  "billing" => %{
    "type" => "toggle",
    "value" => false
  }
}

}

Link to this function

should?(flags, flagName)

Checks if the flag allows this feature to be used

Examples

iex> VexillaClientElixir.should?(%{"untagged" => %{"billing" => %{"type" => "toggle","value" => false}}}, "billing") false

Link to this function

should?(flags, flagName, groupName)

Checks if the flag allows this feature to be used

Examples

iex> VexillaClientElixir.should?(%{"features" => %{"billing" => %{"type" => "toggle","value" => false}}}, "billing", "features") false