Unleash v1.3.0 API Reference

If you have no plans on extending the client, then Unleash will be the main usage point of the library. Upon starting your app, the client is registered with the unleash server, and two GenServers are started, one to fetch and poll for feature flags from the server, and one to send metrics.

An extra fancy Plug and utility functions to help when developing Plug or Phoenix-based applications. It automatically puts together a Unleash.context/0 under the Plug.Conn's Plug.assigns/0.

Used to get all available strategies in the client. You can add your strategies to the client by extending this module

Used to extend the client and create custom strategies. To do so, use this module within your custom strategy and implmenent enabled?/2. Provide a name that is human-readable, as it is logged.

Requires :user_id in Unleash.context/0

Does not require anything in Unleash.context/0

Does not require anything in Unleash.context/0

Does not require anything in Unleash.context/0

Requires :session_id in Unleash.context/0

Requires :user_id in Unleash.context/0

Requires :remote_address in Unleash.context/0

Utilities that might help you create your own strategies.