config

Documentation

Index

• Constants
• func AccessTokenIsSet(filename string) (bool, error)
• func GetConfigFile() string
• type Config
  • func New(filename string, readFile ReadFile) (Config, error)
  • func (c Config) Remove(key string) (Config, error)
  • func (c Config) Update(kvs []string) (Config, []string, error)
• type ReadFile
• type Service
  • func NewService(client resources.Client) Service
  • func (s Service) VerifyAccessToken(accessToken string, baseURI string) bool

Constants

const Filename = ".ldcli-config.yml"

Functions

func AccessTokenIsSet

func AccessTokenIsSet(filename string) (bool, error)

func GetConfigFile

func GetConfigFile() string

GetConfigFile gets the full path to the config file.

Types

type Config

type Config struct {
	AccessToken     string `json:"access-token,omitempty" yaml:"access-token,omitempty"`
	AnalyticsOptOut *bool  `json:"analytics-opt-out,omitempty" yaml:"analytics-opt-out,omitempty"`
	BaseURI         string `json:"base-uri,omitempty" yaml:"base-uri,omitempty"`
	DevStreamURI    string `json:"dev-stream-uri,omitempty" yaml:"dev-stream-uri,omitempty"`
	Environment     string `json:"environment,omitempty" yaml:"environment,omitempty"`
	Flag            string `json:"flag,omitempty" yaml:"flag,omitempty"`
	Output          string `json:"output,omitempty" yaml:"output,omitempty"`
	Project         string `json:"project,omitempty" yaml:"project,omitempty"`
}

Config represents the data stored in the config file.

func New

func New(filename string, readFile ReadFile) (Config, error)

func (Config) Remove

func (c Config) Remove(key string) (Config, error)

Remove validates the key exists but doesn't do anything else since we unset the value when writing to disk.

func (Config) Update

func (c Config) Update(kvs []string) (Config, []string, error)

Update validates the updating fields and sets them on the Config. It returns the updated fields in addition to the Config.

type ReadFile

type ReadFile func(name string) ([]byte, error)

type Service

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

func NewService

func NewService(client resources.Client) Service

func (Service) VerifyAccessToken

func (s Service) VerifyAccessToken(accessToken string, baseURI string) bool

VerifyAccessToken is true if the given access token is valid to make API requests.