config

Documentation

Overview

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Package config represnets configurations for given system Supported configurations are env as of right now.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Index

• type Config
  • func NewConfig(m ReadMode, rs []resource.Resource) *Config
  • func (c *Config) WithReadMode(m ReadMode) *Config
  • func (c *Config) WithResource(rs []resource.Resource) *Config
• type MultiConfig
• type ReadMode
  • func ParseReadMode(s string) (ReadMode, error)
  • func (r ReadMode) IsExt() bool
  • func (r ReadMode) IsFile() bool
  • func (r ReadMode) IsOS() bool

Types

type Config

type Config struct {
	ReadMode                      // Determines the mode in which configuration is read
	Resources []resource.Resource // The resources representing the config source
}

Config represents the configuration for the application. It combines a ReadMode, which determines how the configuration is loaded or interpreted, with a Resource, which points to the underlying source of the configuration (e.g., a local path or a remote URI).

func NewConfig

func NewConfig(m ReadMode, rs []resource.Resource) *Config

func (*Config) WithReadMode

func (c *Config) WithReadMode(m ReadMode) *Config

WithReadMode returns a copy of the Config with a new ReadMode.

func (*Config) WithResource

func (c *Config) WithResource(rs []resource.Resource) *Config

WithResource returns a copy of the Config with a new Resource.

type MultiConfig

type MultiConfig[T any] map[string]*T

Represents maps of prefixes (e.g. "NEON", "UPSTASH", "WEB", "db", "whatever_you-want") to a set of Configs.

type ReadMode

type ReadMode string

const (
	File ReadMode = "file" // Read from a local file (.env, YAML, etc.)
	OS   ReadMode = "os"   // Read from inherited OS environment variables
	Ext  ReadMode = "ext"  // Read from external source (Docker secrets, K8s secrets, etc.)
)

func ParseReadMode

func ParseReadMode(s string) (ReadMode, error)

ParseReadMode converts a string to a ReadMode. Case-insensitive.

func (ReadMode) IsExt

func (r ReadMode) IsExt() bool

func (ReadMode) IsFile

func (r ReadMode) IsFile() bool

func (ReadMode) IsOS

func (r ReadMode) IsOS() bool