runtime

Documentation

Overview

Package runtime provides interfaces for defining Lambda runtimes and appropriate shims for arbitrary language support.

Index

• func Detect(path string) (string, error)
• func Register(name string, runtime Runtime)
• type CompiledRuntime
• type Runtime
  • func ByName(name string) (Runtime, error)

Functions

func Detect

func Detect(path string) (string, error)

Detect returns the name of runtime based on DefaultFile. Function iterates over all runtimes and checks if DefaultFile exists in specified directory.

func Register

func Register(name string, runtime Runtime)

Register runtime by `name`.

Types

type CompiledRuntime

type CompiledRuntime interface {
	// Build performs a build using language-specific conventions
	// such as "main.go" for the build target.
	Build(dir string) error

	// Clean removes the build artifacts after deployment.
	Clean(dir string) error
}

CompiledRuntime is a language runtime requiring compilation.

type Runtime

type Runtime interface {
	// Name returns the canonical runtime to be used, for example
	// since Go must be run as a shim, this is "nodejs", not "golang".
	Name() string

	// Handler returns the handler name for the runtime in the form "<file>.<func>".
	Handler() string

	// Shimmed returns true if the program should be shimmed.
	Shimmed() bool

	// DefaultFile returns default name for a file with handler
	DefaultFile() string
}

Runtime is a language runtime.

func ByName

func ByName(name string) (Runtime, error)

ByName returns the runtime by `name`.