config

Documentation

Overview

Package config contains utilities for reading and parsing service configuration files.

Index

• func Read(path string, replaceEnvs bool, config interface{}) error
• type SanitForYAML
• type Sanitised
  • func (s Sanitised) MarshalJSON() ([]byte, error)
  • func (s Sanitised) MarshalYAML() (interface{}, error)

Functions

func Read

func Read(path string, replaceEnvs bool, config interface{}) error

Read will attempt to read a configuration file path into a structure.

Types

type SanitForYAML

type SanitForYAML map[string]interface{}

SanitForYAML a map to be embedded within a parent object for YAML marshalling.

type Sanitised

type Sanitised map[string]interface{}

Sanitised is a general map[string]interface{} type that tries to marshal into both YAML and JSON in a way that ensure the 'type' field is always first.

func (Sanitised) MarshalJSON

func (s Sanitised) MarshalJSON() ([]byte, error)

MarshalJSON return the config as a JSON blob with the 'type' field first.

func (Sanitised) MarshalYAML

func (s Sanitised) MarshalYAML() (interface{}, error)

MarshalYAML return the config as YAML with the 'type' field first.