types

Documentation

Overview

Package types all types are here

Index

• type ApplicationInformation
• type Configuration
• type HealthzResponse
• type HelloResponse
• type Response
• type UntypedMap
• type User

Types

type ApplicationInformation

type ApplicationInformation struct {
	Title       string
	Description string
}

type Configuration

type Configuration struct {
	MetricAddress          string `env:"METRIC_ADDRESS" env-default:":9090" yaml:"metric_address"`
	APIAddress             string `env:"API_ADDRESS" env-default:":8080" yaml:"api_address"`
	SentryDsn              string `env:"SENTRY_DSN" env-default:"" yaml:"sentry_dsn"`
	LogFormat              string `env:"LOG_FORMAT" env-default:"text" yaml:"log_format"`
	ApplicationTitle       string `env:"APPLICATION_TITLE" env-default:"goAPIBaseProject" yaml:"application_title"`
	ApplicationDescription string `env:"APPLICATION_DESCRIPTION" env-default:"goAPIBaseProject" yaml:"application_description"`
	WebsocketOrigin        string `env:"WEBSOCKET_ORIGIN" env-default:"*" yaml:"websocket_origin"`
	DatabaseDriver         string `env:"DATABASE_DRIVER" yaml:"database_driver" env-default:"sqlite3"`
	DatabaseConnection     string `env:"DATABASE_CONNECTION" yaml:"database_connection" env-default:"file:db.sqlite?cache=shared"`
}

Configuration is used to store the configuration by cleanenv package

type HealthzResponse

type HealthzResponse struct {
	Name    string `json:"name"`
	Message string `json:"msg"`
}

type HelloResponse

type HelloResponse struct {
	Greeting string    `json:"greeting"`
	Time     time.Time `json:"time"`
}

type Response

type Response interface {
	HealthzResponse |
		HelloResponse
}

Response any acceptable response will be here using generic it will accept one of the given types

type UntypedMap

type UntypedMap map[any]any

UntypedMap a type that used to create untyped map (for json)

type User

type User struct {
	Id      int64
	Name    string
	Salt    string
	Age     int
	Passwd  string    `xorm:"varchar(200)"`
	Created time.Time `xorm:"created"`
	Updated time.Time `xorm:"updated"`
}