config

package

v0.1.434 Latest Latest Go to latest Published: Jun 25, 2025 License: Apache-2.0 Imports: 8 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

gitlab.com/fabriktor/pkg

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type EnvKey
type Message
type QVals
- func (q QVals) String() string
type Vars
type VarsKey

Constants ¶

View Source

const (
	MimeJSON     = "application/json"
	MimeHTML     = "text/html; charset=utf-8"
	EncodingGzip = "gzip"
)

Mime types.

View Source

const (
	DefaultTimeout        = 2 * time.Minute
	DefaultIdempotencyTTL = 5 * time.Minute
)

Timeouts.

View Source

const (
	AccessControlAllowMethodsKey = "Access-Control-Allow-Methods"
	AccessControlAllowHeadersKey = "Access-Control-Allow-Headers"
	AccessControlAllowOriginKey  = "Access-Control-Allow-Origin"
	AccessControlRequestHeaders  = "Access-Control-Request-Headers"
	Origin                       = "Origin"
	CFConnectingIPKey            = "CF-Connecting-IP"
	AllowedOriginsKey            = "ALLOWED_ORIGINS"
	XForwardedForKey             = "X-Forwarded-For"
	XRealIPKey                   = "X-Real-IP"
	SubpathKey                   = "subpath"
	AllowKey                     = "Allow"
)

Variables ¶

View Source

var (
	HeaderAuthorization      = http.CanonicalHeaderKey("authorization")
	HeaderContentType        = http.CanonicalHeaderKey("content-type")
	HeaderContentLength      = http.CanonicalHeaderKey("content-length")
	HeaderContentEncoding    = http.CanonicalHeaderKey("content-encoding")
	HeaderContentDisposition = http.CanonicalHeaderKey("content-disposition")
	HeaderAcceptEncoding     = http.CanonicalHeaderKey("accept-encoding")
	HeaderXForwardedProto    = http.CanonicalHeaderKey("x-forwarded-proto")
	HeaderXForwardedFor      = http.CanonicalHeaderKey("x-forwarded-for")
	HeaderUserAgent          = http.CanonicalHeaderKey("user-agent")
)

Headers (Canonicalized for Proper Casing).

View Source

var (
	PrefixBearer = http.CanonicalHeaderKey("bearer")
	PrefixMod    = http.CanonicalHeaderKey("mod")
)

Authentication prefixes.

View Source

var (
	EnvKeyAddress             = envKey("address")
	EnvKeyEnvironment         = envKey("environment")
	EnvKeyMongoCluster        = envKey("mongo_cluster")
	EnvKeyMongoConnStr        = envKey("mongo_conn_str")
	EnvKeyRedisHost           = envKey("redis_host")
	EnvKeyRedisPort           = envKey("redis_port")
	EnvKeyMongoConnStrDev     = envKey("mongo_conn_str_dev")
	EnvKeyMongoConnStrStaging = envKey("mongo_conn_str_staging")
	EnvKeyMongoConnStrProd    = envKey("mongo_conn_str_prod")
	EnvKeyMongoClusterDev     = envKey("mongo_cluster_dev")
	EnvKeyMongoClusterStaging = envKey("mongo_cluster_staging")
	EnvKeyMongoClusterProd    = envKey("mongo_cluster_prod")
	EnvKeyRedisHostDev        = envKey("redis_host_dev")
	EnvKeyRedisHostStaging    = envKey("redis_host_staging")
	EnvKeyRedisHostProd       = envKey("redis_host_prod")
	EnvKeyRedisPortDev        = envKey("redis_port_dev")
	EnvKeyRedisPortStaging    = envKey("redis_port_staging")
	EnvKeyRedisPortProd       = envKey("redis_port_prod")
)

View Source

var (
	MsgAuthentication = msg("authentication successful")
	MsgInsertOne      = msg("record created successfully")
	MsgFindOne        = msg("record retrieved successfully")
	MsgFindMany       = msg("records retrieved successfully")
	MsgReplaceOne     = msg("record updated successfully")
	MsgDeleteOne      = msg("record deleted successfully")
	MsgDeleteMany     = msg("records deleted successfully")
	MsgSearchMany     = msg("records found successfully")
	MsgNotFound       = msg("not found")
)

View Source

var IPHeaders = []string{XForwardedForKey, XRealIPKey, CFConnectingIPKey}

Functions ¶

This section is empty.

Types ¶

type EnvKey ¶ added in v0.1.105

type EnvKey = string

type Message ¶

type Message = string

type QVals ¶ added in v0.1.61

type QVals []string

func (QVals) String ¶ added in v0.1.61

func (q QVals) String() string

type Vars ¶ added in v0.1.10

type Vars struct {
	Svc       string
	Ressource string
	Path      map[string]string
	Query     map[string][]string
}

Vars holds extracted path and query parameters.

func (*Vars) GetPath ¶ added in v0.1.32

func (v *Vars) GetPath(key string) (string, error)

GetPath returns the value of a path param or an error if not found or empty.

func (*Vars) GetQuery ¶ added in v0.1.32

func (v *Vars) GetQuery(key string, errOnEmpty bool) (QVals, error)

GetQuery returns the values of a query param or an error if not found or empty (depending on errOnEmpty).

func (*Vars) GetQueryFirst ¶ added in v0.1.32

func (v *Vars) GetQueryFirst(key string, errOnEmpty bool) (string, error)

GetQueryFirst returns the first value of a query param or an error if missing or empty (depending on errOnEmpty).

type VarsKey ¶ added in v0.1.10

type VarsKey struct{}

Source Files ¶

View all Source files

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