options

package

v0.0.3 Latest Latest Go to latest Published: Jun 25, 2024 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/prefab-cloud/prefab-cloud-go

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func StringPtr(str string) *string
type Datasource
type OnInitializationFailure
type Options
- func NewOptions(modifyFn func(*Options)) Options
- func (o *Options) APIKeySettingOrEnvVar() (string, error)
- func (o *Options) PrefabAPIURLEnvVarOrSetting() (string, error)

Constants ¶

View Source

const (
	// #nosec G101 -- This is just the env var name
	APIKeyEnvVar = "PREFAB_API_KEY"
	APIURLVar    = "PREFAB_API_URL"
)

Variables ¶

View Source

var DefaultOptions = Options{
	APIKey:                       "",
	APIUrl:                       "https://api.prefab.cloud",
	Datasource:                   ALL,
	InitializationTimeoutSeconds: timeoutDefault,
	OnInitializationFailure:      RAISE,
	EnvironmentNames:             getDefaultEnvironmentNames(),
	ConfigDirectory:              getHomeDir(),
	ConfigOverrideDirectory:      StringPtr("."),
	GlobalContext:                contexts.NewContextSet(),
}

Functions ¶

func StringPtr ¶

func StringPtr(str string) *string

Types ¶

type Datasource ¶

type Datasource int

const (
	ALL Datasource = iota
)

type OnInitializationFailure ¶

type OnInitializationFailure int

const (
	RAISE  OnInitializationFailure = iota // RAISE = 0
	UNLOCK                                // UNLOCK = 1
)

type Options ¶

type Options struct {
	ConfigDirectory              *string
	ConfigOverrideDirectory      *string
	GlobalContext                *contexts.ContextSet
	APIKey                       string
	APIUrl                       string
	EnvironmentNames             []string
	Datasource                   Datasource
	InitializationTimeoutSeconds float64
	OnInitializationFailure      OnInitializationFailure
}

func NewOptions ¶

func NewOptions(modifyFn func(*Options)) Options

func (*Options) APIKeySettingOrEnvVar ¶

func (o *Options) APIKeySettingOrEnvVar() (string, error)

func (*Options) PrefabAPIURLEnvVarOrSetting ¶

func (o *Options) PrefabAPIURLEnvVarOrSetting() (string, error)

Source Files ¶

View all Source files

options.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL