envi

package module
v1.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 10, 2021 License: Apache-2.0 Imports: 6 Imported by: 0

README

envi

Installation

go get github.com/Clarilab/envi

Importing

import "github.com/Clarilab/envi"

Features

// LoadEnvVars loads the given Environment Variables.
// All Vars are required.
func LoadEnvVars(required []string) (loadedVars map[string]string, err error)


// LoadEnvVars loads the given Environment Variables.
// These are seperated into required and optional Vars.
func LoadEnvVarsWithOptional(required, optional []string) (loadedVars map[string]string, err error)

// LoadFromSecretFile parses a json file to load all mappings
// fileName is optional
// default value is ./secretFile
func LoadFromSecretFile(fileName ...string) error

Secretfile Example

{
    "key1":"value1",
    "key2":"value2",
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func LoadConfig added in v1.1.2

func LoadConfig(fileName ...string) (map[string]string, error)

LoadConfig parses a file to load all Mappings and returns the data as map[string]string fileName is optional default value is ./secretFile

func LoadEnvVars

func LoadEnvVars(required []string) (loadedVars map[string]string, err error)

LoadEnvVars loads the given Environment Variables. All Vars are required.

func LoadEnvVarsWithOptional added in v1.1.0

func LoadEnvVarsWithOptional(required, optional []string) (loadedVars map[string]string, err error)

LoadEnvVarsWithOptional loads the given Environment Variables. These are seperated into required and optional Vars.

func LoadFromSecretFile added in v1.1.1

func LoadFromSecretFile(fileName ...string) error

LoadFromSecretFile parses a json file to load all mappings fileName is optional default value is ./secretFile

Types

type RequiredEnvVarsMissing

type RequiredEnvVarsMissing struct {
	MissingVars []string
}

RequiredEnvVarsMissing says, that a required Environment Variable is not given.

func (*RequiredEnvVarsMissing) Error

func (e *RequiredEnvVarsMissing) Error() string

Jump to

Keyboard shortcuts

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