config

Documentation

Index

• Variables
• type Action
• type ActionAuth
• type ActionAuthQuery
• type Config
  • func New(loaders ...Loader) (*Config, error)
  • func (c *Config) Merge(src *Config)
  • func (c *Config) Validate(tag string) error
• type Loader
• type Log
• type Server
• type ServerTLS

Variables

var DefaultConfig = &Config{
	Log: Log{
		Level:      "debug",
		Dir:        "./logs",
		FileFormat: "2006-01-02.log",
	},
	Server: Server{
		Address: ":3000",
		Header:  "CatSync",
	},
	Actions: []Action{
		{
			Route:      "/",
			Action:     action.String,
			ActionData: "Hello from CatSync!",
		},
		{
			Route:  "/json",
			Action: action.JSON,
			ActionData: fiber.Map{
				"msg": "Hello from CatSync!",
				"data": fiber.Map{
					"version": version.GetFormatVersion(),
				},
			},
		},
	},
}

var ErrConfigNotFound = errors.New("config file not found")

var Path string

Types

type Action

type Action struct {
	Route          string      `json:"route"          yaml:"route"`
	Action         action.Type `json:"action"         yaml:"action"`
	ActionData     action.Data `json:"actionData"     yaml:"actionData"`
	ResponseHeader http.Header `json:"responseHeader" optional:"true"   yaml:"responseHeader"`
	Auth           ActionAuth  `json:"auth"           optional:"true"   yaml:"auth"`
}

type ActionAuth

type ActionAuth struct {
	UA    string          `json:"ua"    optional:"true" yaml:"ua"`
	Query ActionAuthQuery `json:"query" optional:"true" yaml:"query"`
}

type ActionAuthQuery

type ActionAuthQuery struct {
	Map            map[string]string `json:"map"            yaml:"map"`
	IgnoreCaseCase bool              `json:"ignoreCaseCase" optional:"true" yaml:"ignoreCaseCase"`
}

type Config

type Config struct {
	Log     Log      `json:"log"     yaml:"log"`
	Server  Server   `json:"server"  yaml:"server"`
	Actions []Action `json:"actions" optional:"true" yaml:"actions"`
}

func New

func New(loaders ...Loader) (*Config, error)

func (*Config) Merge

func (c *Config) Merge(src *Config)

func (*Config) Validate

func (c *Config) Validate(tag string) error

type Loader

type Loader interface {
	GetTag() string
	Load(cfg *Config, fileName string) error
	Save(cfg *Config, fileName string) error
	// GetAllowFileExtensions lowercase
	GetAllowFileExtensions() []string
}

type Log

type Log struct {
	Dir        string `json:"dir"        optional:"true"   yaml:"dir"`
	Level      string `json:"level"      optional:"true"   yaml:"level"`
	FileFormat string `json:"fileFormat" yaml:"fileFormat"`
}

type Server

type Server struct {
	Address string    `json:"address" yaml:"address"`
	Header  string    `json:"header"  optional:"true" yaml:"header"`
	TLS     ServerTLS `json:"tls"     optional:"true" yaml:"tls"`
}

type ServerTLS

type ServerTLS struct {
	Cert string `json:"cert" yaml:"cert"`
	Key  string `json:"key"  yaml:"key"`
}