config

Documentation

Overview

Package config the configuration

Index

• func NewContext(ctx context.Context, config Config) context.Context
• type Config
  • func DefaultConfig() Config
  • func FromContext(ctx context.Context) Config
  • func ReadConfig(path string) (config Config, err error)

Functions

func NewContext

func NewContext(ctx context.Context, config Config) context.Context

NewContext returns a context that contains the given Config.

Types

type Config

type Config struct {
	// Cache
	Cache cache.Options `yaml:"cache"`

	// Fetch
	Fetch fetch.Options `yaml:"fetch"`

	// JS
	JS js.Options `yaml:"js"`
}

Config The cloudcat configuration

func DefaultConfig

func DefaultConfig() Config

DefaultConfig The default configuration

func FromContext

func FromContext(ctx context.Context) Config

FromContext returns the Config stored in ctx by NewContext, or the default Config if there is none.

func ReadConfig

func ReadConfig(path string) (config Config, err error)

ReadConfig read configuration from the file. If the configuration file is not existing then create it with default configuration.