config

Documentation

Overview

Package config load settings from external files or environment variables and manage their values.

Index

• Variables
• type S3
  • func NewS3() (*S3, error)

Variables

var (
	// ErrInvalidRegion is an error that occurs when the region is invalid.
	ErrInvalidRegion = errors.New("invalid region")
	// ErrInvalidBucket is an error that occurs when the bucket is invalid.
	ErrInvalidBucket = errors.New("invalid bucket")
)

Types

type S3

type S3 struct {
	// Bucket is the name of the S3 bucket. The default value is "naraku".
	Bucket model.Bucket `env:"naraku_S3_BUCKET" envDefault:"naraku"`
	// Region is the name of the AWS region. The default value is "ap-northeast-1".
	Region model.Region `env:"naraku_S3_REGION" envDefault:"ap-northeast-1"`
}

S3 is a struct that contains the settings for the S3 storage.

func NewS3

func NewS3() (*S3, error)

NewS3 returns a new S3 struct.