apps

Documentation

Index

• Variables
• type Instance
  • func NewInstance(root, localID, platformID string) *Instance
  • func (i *Instance) BuildSettings() (appfile.Build, error)
  • func (i *Instance) CacheMetadata(md *meta.Data) error
  • func (i *Instance) CachePath() (string, error)
  • func (i *Instance) CachedMetadata() (*meta.Data, error)
  • func (i *Instance) Close() error
  • func (i *Instance) Experiments(environ []string) (*experiments.Set, error)
  • func (i *Instance) GlobalCORS() (appfile.CORS, error)
  • func (i *Instance) Lang() appfile.Lang
  • func (i *Instance) LocalID() string
  • func (i *Instance) Name() string
  • func (i *Instance) PlatformID() string
  • func (i *Instance) PlatformOrLocalID() string
  • func (i *Instance) Root() string
  • func (i *Instance) Tutorial() string
  • func (i *Instance) Unwatch(id WatchSubscriptionID)
  • func (i *Instance) Watch(fn WatchFunc) (WatchSubscriptionID, error)
• type Manager
  • func NewManager(db *sql.DB) *Manager
  • func (mgr *Manager) Close() error
  • func (mgr *Manager) FindLatestByPlatformID(platformID string) (*Instance, error)
  • func (mgr *Manager) FindLatestByPlatformOrLocalID(id string) (*Instance, error)
  • func (mgr *Manager) List() ([]*Instance, error)
  • func (mgr *Manager) RegisterAppListener(fn func(*Instance))
  • func (mgr *Manager) Track(appRoot string, options ...TrackOption) (*Instance, error)
  • func (mgr *Manager) WatchAll(fn WatchFunc) error
• type TrackOption
  • func WithTutorial(tutorial string) TrackOption
• type WatchFunc
• type WatchSubscriptionID

Variables

var ErrNotFound = errors.New("app not found")

Types

type Instance

type Instance struct {
	// contains filtered or unexported fields
}

Instance describes an app instance known by the Encore daemon.

func NewInstance

func NewInstance(root, localID, platformID string) *Instance

func (*Instance) BuildSettings

func (i *Instance) BuildSettings() (appfile.Build, error)

func (*Instance) CacheMetadata

func (i *Instance) CacheMetadata(md *meta.Data) error

CacheMetadata caches the metadata for this app onto the file system

func (*Instance) CachePath

func (i *Instance) CachePath() (string, error)

CachePath returns the path to the cache directory for this app. It creates the directory if it does not exist.

func (*Instance) CachedMetadata

func (i *Instance) CachedMetadata() (*meta.Data, error)

CachedMetadata returns the cached metadata for this app, if any

func (*Instance) Close

func (i *Instance) Close() error

func (*Instance) Experiments

func (i *Instance) Experiments(environ []string) (*experiments.Set, error)

Experiments returns the enabled experiments for this app.

Note: we read the app file here instead of a cached value so we can detect changes between runs of the compiler if we're in watch mode.

func (*Instance) GlobalCORS

func (i *Instance) GlobalCORS() (appfile.CORS, error)

GlobalCORS returns the CORS configuration for the app which will be applied against all API gateways into the app

func (*Instance) Lang

func (i *Instance) Lang() appfile.Lang

func (*Instance) LocalID

func (i *Instance) LocalID() string

LocalID reports a local, random id unique for this app, as persisted in the .encore/manifest.json file. It always returns a non-empty string.

func (*Instance) Name

func (i *Instance) Name() string

Name returns the platform ID for the app, or if there isn't one it returns the folder name the app is in.

func (*Instance) PlatformID

func (i *Instance) PlatformID() string

PlatformID reports the Encore Platform's ID for this app. If the app is not linked it reports the empty string.

func (*Instance) PlatformOrLocalID

func (i *Instance) PlatformOrLocalID() string

PlatformOrLocalID reports PlatformID() if set and otherwise LocalID().

func (*Instance) Root

func (i *Instance) Root() string

Root returns the filesystem path for the app root. It always returns a non-empty string.

func (*Instance) Tutorial

func (i *Instance) Tutorial() string

func (*Instance) Unwatch

func (i *Instance) Unwatch(id WatchSubscriptionID)

func (*Instance) Watch

func (i *Instance) Watch(fn WatchFunc) (WatchSubscriptionID, error)

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

Manager keeps track of known apps and watches them for changes.

func NewManager

func NewManager(db *sql.DB) *Manager

func (*Manager) Close

func (mgr *Manager) Close() error

func (*Manager) FindLatestByPlatformID

func (mgr *Manager) FindLatestByPlatformID(platformID string) (*Instance, error)

FindLatestByPlatformID finds the most recently updated app instance with the given platformID. If no such app is found it reports an error matching ErrNotFound.

func (*Manager) FindLatestByPlatformOrLocalID

func (mgr *Manager) FindLatestByPlatformOrLocalID(id string) (*Instance, error)

func (*Manager) List

func (mgr *Manager) List() ([]*Instance, error)

List lists all known apps.

func (*Manager) RegisterAppListener

func (mgr *Manager) RegisterAppListener(fn func(*Instance))

RegisterAppListener registers a callback that gets invoked every time an app is tracked.

func (*Manager) Track

func (mgr *Manager) Track(appRoot string, options ...TrackOption) (*Instance, error)

Track begins tracking an app, and marks it as updated if the app is already tracked.

func (*Manager) WatchAll

func (mgr *Manager) WatchAll(fn WatchFunc) error

WatchAll watches all apps for changes.

type TrackOption

type TrackOption func(*Instance) error

func WithTutorial

func WithTutorial(tutorial string) TrackOption

type WatchFunc

type WatchFunc func(*Instance, []watcher.Event)

WatchFunc is the signature of functions registered as app watchers.

type WatchSubscriptionID

type WatchSubscriptionID int64