config

Documentation

Overview

Package config implements the functions, types, and interfaces for the module.

Package config implements the functions, types, and interfaces for the module.

Index

• Constants
• Variables
• type Config
  • func New(opts ...Option) Config
• type Decoder
• type Encoder
• type KeyValue
• type Merge
• type Observer
• type Option
  • func WithDecoder(d Decoder) Option
  • func WithMergeFunc(m Merge) Option
  • func WithResolveActualTypes(enableConvertToType bool) Option
  • func WithResolver(r Resolver) Option
  • func WithSource(s ...Source) Option
• type Reader
• type Resolver
• type Source
• type SourceOption
• type SourceOptionSetting
  • func WithOptions(options ...Option) SourceOptionSetting
• type Value
• type Watcher

Constants

const (
	EnvPrefix = "ORIGADMIN_SERVICE"
)

Variables

var (
	// ErrNotFound defined error from kratos config package
	ErrNotFound = kratosconfig.ErrNotFound
)

Types

type Config

type Config = kratosconfig.Config

Define types from kratos config package

func New

func New(opts ...Option) Config

New returns a new config instance

type Decoder

type Decoder = kratosconfig.Decoder

Define types from kratos config package

type Encoder

type Encoder func(v any) ([]byte, error)

Encoder is a function that takes a value and returns a byte slice and an error.

type KeyValue

type KeyValue = kratosconfig.KeyValue

Define types from kratos config package

type Merge

type Merge = kratosconfig.Merge

Define types from kratos config package

type Observer

type Observer = kratosconfig.Observer

Define types from kratos config package

type Option

type Option = kratosconfig.Option

Define types from kratos config package

func WithDecoder

func WithDecoder(d Decoder) Option

WithDecoder sets the decoder

func WithMergeFunc

func WithMergeFunc(m Merge) Option

WithMergeFunc sets the merge function

func WithResolveActualTypes

func WithResolveActualTypes(enableConvertToType bool) Option

WithResolveActualTypes enables resolving actual types

func WithResolver

func WithResolver(r Resolver) Option

WithResolver sets the resolver

func WithSource

func WithSource(s ...Source) Option

WithSource sets the source

type Reader

type Reader = kratosconfig.Reader

Define types from kratos config package

type Resolver

type Resolver = kratosconfig.Resolver

Define types from kratos config package

type Source

type Source = kratosconfig.Source

Define types from kratos config package

type SourceOption

type SourceOption struct {
	Options []Option
	Decoder Decoder
	Encoder Encoder
}

type SourceOptionSetting

type SourceOptionSetting = func(s *SourceOption)

SourceOptionSetting is a function that takes a pointer to a SourceOption struct and modifies it.

func WithOptions

func WithOptions(options ...Option) SourceOptionSetting

WithOptions sets the options field of the SourceOption struct.

type Value

type Value = kratosconfig.Value

Define types from kratos config package

type Watcher

type Watcher = kratosconfig.Watcher

Define types from kratos config package