project

Documentation

Index

• Variables
• type BaseConfig
• type Config
  • func ConfigFromProjectPath(projPath string) (*Config, error)
  • func (p *Config) ToFile() error
• type DockerConfig
• type Function
  • func FunctionFromHandler(handlerFile string, config *HandlerConfig) (Function, error)
  • func (f *Function) GetRuntime() (runtime.Runtime, error)
  • func (f *Function) RelativeHandlerPath(s *Project) (string, error)
• type HandlerConfig
• type Project
  • func FromConfig(c *Config) (*Project, error)
  • func New(config BaseConfig) *Project
  • func (p *Project) IsPreviewFeatureEnabled(feat preview.Feature) bool

Variables

var DefaultOTELCollectorVersion string

Types

type BaseConfig

type BaseConfig struct {
	Name            string            `yaml:"name"`
	Dir             string            `yaml:"-"`
	Handlers        []any             `yaml:"handlers"`
	PreviewFeatures []preview.Feature `yaml:"preview-features"`
}

type Config

type Config struct {
	BaseConfig       `yaml:",inline"`
	ConcreteHandlers []*HandlerConfig `yaml:"-"`
}

func ConfigFromProjectPath

func ConfigFromProjectPath(projPath string) (*Config, error)

ConfigFromProjectPath - loads the config nitric.yaml file from the project path, defaults to the current working directory

func (*Config) ToFile

func (p *Config) ToFile() error

type DockerConfig

type DockerConfig struct {
	File string
	Args map[string]string
}

type Function

type Function struct {
	// Parent Project backreference
	Project *Project
	// The functions unique name
	Name string `yaml:"-"`
	// The location of the function handler
	Handler string `yaml:"handler"`
	// The functions type
	Config *HandlerConfig `yaml:"-"`
	// The writer for the build logs, defaults to stdout
	BuildLogger io.Writer
}

func FunctionFromHandler

func FunctionFromHandler(handlerFile string, config *HandlerConfig) (Function, error)

func (*Function) GetRuntime

func (f *Function) GetRuntime() (runtime.Runtime, error)

func (*Function) RelativeHandlerPath

func (f *Function) RelativeHandlerPath(s *Project) (string, error)

type HandlerConfig

type HandlerConfig struct {
	Type   string        `yaml:"type" mapstructure:"type"`
	Match  string        `yaml:"match" mapstructure:"match"`
	Docker *DockerConfig `yaml:"docker,omitempty" mapstructure:"docker,omitempty"`
}

type Project

type Project struct {
	Dir             string               `yaml:"-"`
	Name            string               `yaml:"name"`
	Functions       map[string]*Function `yaml:"functions,omitempty"`
	PreviewFeatures []preview.Feature    `yaml:"-"`
	History         *history.History     `yaml:"-"`
}

func FromConfig

func FromConfig(c *Config) (*Project, error)

func New

func New(config BaseConfig) *Project

func (*Project) IsPreviewFeatureEnabled

func (p *Project) IsPreviewFeatureEnabled(feat preview.Feature) bool