cloud

Documentation

Index

• type LocalCloud
  • func New(projectName string, opts LocalCloudOptions) (*LocalCloud, error)
  • func (lc *LocalCloud) AddBatch(batchName string) (int, error)
  • func (lc *LocalCloud) AddService(serviceName string) (int, error)
  • func (lc *LocalCloud) Stop()
• type LocalCloudMode
• type LocalCloudOptions
• type ServiceName
• type Subscribable

Types

type LocalCloud

type LocalCloud struct {
	Apis       *apis.LocalApiGatewayService
	Batch      *batch.LocalBatchService
	KeyValue   *keyvalue.BoltDocService
	Gateway    *gateway.LocalGatewayService
	Http       *http.LocalHttpProxy
	Resources  *resources.LocalResourcesService
	Schedules  *schedules.LocalSchedulesService
	Secrets    *secrets.DevSecretService
	Storage    *storage.LocalStorageService
	Topics     *topics.LocalTopicsAndSubscribersService
	Websockets *websockets.LocalWebsocketService
	Queues     *queues.LocalQueuesService
	Databases  *sql.LocalSqlServer
	// contains filtered or unexported fields
}

func New

func New(projectName string, opts LocalCloudOptions) (*LocalCloud, error)

func (*LocalCloud) AddBatch

func (lc *LocalCloud) AddBatch(batchName string) (int, error)

func (*LocalCloud) AddService

func (lc *LocalCloud) AddService(serviceName string) (int, error)

func (*LocalCloud) Stop

func (lc *LocalCloud) Stop()

StartLocalNitric - starts the Nitric Server, including plugins and their local dependencies (e.g. local versions of cloud services)

type LocalCloudMode

type LocalCloudMode string

LocalCloudMode type run or start

const (
	// LocalCloudModeRun - run mode
	LocalCloudModeRun LocalCloudMode = "run"
	// LocalCloudModeStart - start mode
	LocalCloudModeStart LocalCloudMode = "start"
)

type LocalCloudOptions

type LocalCloudOptions struct {
	TLSCredentials  *gateway.TLSCredentials
	LogWriter       io.Writer
	LocalConfig     localconfig.LocalConfiguration
	MigrationRunner sql.MigrationRunner
	LocalCloudMode  LocalCloudMode
}

type ServiceName

type ServiceName = string

type Subscribable

type Subscribable[T any, A any] interface {
	SubscribeToState(fn func(T))
	SubscribeToAction(fn func(A)) // used to subscribe to api calls, ws messages, topic deliveries etc
}