client

Documentation

Index

• type Client
  • func NewClient(a driver.Driver) *Client
  • func (c *Client) Disable(featureName string) error
  • func (c *Client) DisableForActors(featureName string, actors ...actor.Actor) error
  • func (c *Client) DisableForGroups(featureName string, groups ...string) error
  • func (c *Client) DisableForPercentageOfActors(featureName string) error
  • func (c *Client) DisableForPercentageOfTime(featureName string) error
  • func (c *Client) Enable(featureName string) error
  • func (c *Client) EnableForActors(featureName string, actors ...actor.Actor) error
  • func (c *Client) EnableForGroups(featureName string, groups ...string) error
  • func (c *Client) EnableForPercentageOfActors(featureName string, percentage int) error
  • func (c *Client) EnableForPercentageOfTime(featureName string, percentage int) error
  • func (c *Client) IsEnabled(featureName string, actors ...actor.Actor) (bool, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is used to access the feature flags.

func NewClient

func NewClient(a driver.Driver) *Client

NewClient initializes a client with a store driver. It assumes that the driver is properly configured. See flipper.NewClient as a shortcut to initialize a client.

func (*Client) Disable

func (c *Client) Disable(featureName string) error

Disable disables a feature globally. Actors might still have the feature enabled if other gates are open.

func (*Client) DisableForActors

func (c *Client) DisableForActors(featureName string, actors ...actor.Actor) error

DisableForActors disables a featue for a list of actors.

func (*Client) DisableForGroups

func (c *Client) DisableForGroups(featureName string, groups ...string) error

DisableForGroups disables a feature for a list of groups.

func (*Client) DisableForPercentageOfActors

func (c *Client) DisableForPercentageOfActors(featureName string) error

DisableForPercentageOfActors disables a feature for a percentage of the actors checked.

func (*Client) DisableForPercentageOfTime

func (c *Client) DisableForPercentageOfTime(featureName string) error

DisableForPercentageOfTime disables a feature for a percentage of the checks.

func (*Client) Enable

func (c *Client) Enable(featureName string) error

Enable enables a feature globally, for every actor.

func (*Client) EnableForActors

func (c *Client) EnableForActors(featureName string, actors ...actor.Actor) error

EnableForActors enables a featue for a list of actors.

func (*Client) EnableForGroups

func (c *Client) EnableForGroups(featureName string, groups ...string) error

EnableForGroups enables a featue for a list of groups.

func (*Client) EnableForPercentageOfActors

func (c *Client) EnableForPercentageOfActors(featureName string, percentage int) error

EnableForPercentageOfActors enables a feature for a percentage of the actors checked.

func (*Client) EnableForPercentageOfTime

func (c *Client) EnableForPercentageOfTime(featureName string, percentage int) error

EnableForPercentageOfTime enables a feature for a percentage of the checks.

func (*Client) IsEnabled

func (c *Client) IsEnabled(featureName string, actors ...actor.Actor) (bool, error)

IsEnabled checks if a feature is enabled. It uses only global checks when there are not actors in the list. This check is accumulative, it only returns true if the feature is enabled for every actor. It returns false if the feature is disabled for any of the actors.