View Source OpenFeature.Client (OpenFeature v0.1.1)

@type t() :: %OpenFeature.Client{
  context: OpenFeature.Types.context(),
  domain: OpenFeature.Types.domain(),
  hooks: [OpenFeature.Hook.t()],
  provider: OpenFeature.Provider.t()
}

Functions

add_event_handler(client, type, handler)

(since 0.1.0)

@spec add_event_handler(
  client :: t(),
  type :: OpenFeature.Types.event_type(),
  handler :: OpenFeature.Types.event_handler()
) :: :ok

Adds an event handler for the client.

If the event type is the same as the client's provider state, the handler will be executed immediately.

add_hooks(client, hooks)

(since 0.1.0)

@spec add_hooks(client :: t(), hooks :: [OpenFeature.Hook.t()]) :: t()

Adds hooks to the end of the list of current client hooks.

clear_handlers(client)

(since 0.1.0)

@spec clear_handlers(client :: t()) :: :ok

Clears all event handlers for the client.

clear_hooks(client)

(since 0.1.0)

@spec clear_hooks(client :: t()) :: t()

Clears all hooks for the client.

get_boolean_details(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_boolean_details(
  client :: t(),
  key :: binary(),
  default :: boolean(),
  opts :: options()
) :: OpenFeature.EvaluationDetails.t()

Returns the evaluation details for a given client flag with boolean value.

get_boolean_value(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_boolean_value(
  client :: t(),
  key :: binary(),
  default :: boolean(),
  opts :: options()
) :: boolean()

Returns a boolean value for a given client flag.

get_context(client)

(since 0.1.0)

@spec get_context(client :: t()) :: OpenFeature.Types.context()

Retrieves the context of the client.

get_hooks(client)

(since 0.1.0)

@spec get_hooks(client :: t()) :: [OpenFeature.Hook.t()]

Retrieves the list of hooks for the client.

get_map_details(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_map_details(
  client :: t(),
  key :: binary(),
  default :: map(),
  opts :: options()
) :: OpenFeature.EvaluationDetails.t()

Returns the evaluation details for a given client flag with map value.

get_map_value(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_map_value(
  client :: t(),
  key :: binary(),
  default :: map(),
  opts :: options()
) :: map()

Returns a map value for a given client flag.

get_number_details(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_number_details(
  client :: t(),
  key :: binary(),
  default :: number(),
  opts :: options()
) :: OpenFeature.EvaluationDetails.t()

Returns the evaluation details for a given client flag with number value.

get_number_value(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_number_value(
  client :: t(),
  key :: binary(),
  default :: number(),
  opts :: options()
) :: number()

Returns a number value for a given client flag.

get_string_details(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_string_details(
  client :: t(),
  key :: binary(),
  default :: binary(),
  opts :: options()
) :: OpenFeature.EvaluationDetails.t()

Returns the evaluation details for a given client flag with string value.

get_string_value(client, key, default, opts \\ [])

(since 0.1.0)

@spec get_string_value(
  client :: t(),
  key :: binary(),
  default :: binary(),
  opts :: options()
) :: binary()

Returns a string value for a given client flag.

list_handlers(client, type)

(since 0.1.0)

@spec list_handlers(client :: t(), type :: OpenFeature.Types.event_type()) :: [
  OpenFeature.Types.event_handler()
]

Lists all event handlers for the client.

remove_event_handler(client, type, handler)

(since 0.1.0)

@spec remove_event_handler(
  client :: t(),
  type :: OpenFeature.Types.event_type(),
  handler :: OpenFeature.Types.event_handler()
) :: :ok

Removes an event handler for the client.

set_context(client, context)

(since 0.1.0)

@spec set_context(client :: t(), context :: OpenFeature.Types.context()) :: t()

Sets the context for the client.