API.md

API Reference

Table of Contents

• Classes
  • Utils
  • AppTfAws
  • AppSim
  • App
  • AppBase
• Interfaces
  • IApp
• Structs
  • AppProps

Utils (preflight class)

No description

Constructor

new(): Utils

Properties

No properties

Methods

Signature	Description
static inflight exec(command: str, env: MutMap, cwd: str): inflight (): void	No description
static execSync(command: str, env: MutMap, cwd: str): void	No description
static inflight serveStaticFiles(path: str, port: num): inflight (): void	No description

AppTfAws (preflight class)

No description

Constructor

new(props: AppProps): AppTfAws

Properties

No properties

Methods

Signature	Description
_preSynthesize(): void	No description
getUrl(): str	No description
addEnvironment(key: str, value: str): void	No description

AppSim (preflight class)

No description

Constructor

new(props: AppProps): AppSim

Properties

Name	Type	Description
url	str	No description

Methods

Signature	Description
getUrl(): str	No description
addEnvironment(key: str, value: str): void	No description

App (preflight class)

No description

Constructor

new(props: AppProps): App

Properties

Name	Type	Description
url	str	No description

Methods

Signature	Description
addEnvironment(key: str, value: str): void	No description

AppBase (preflight class)

No description

Constructor

new(props: AppProps): AppBase

Properties

No properties

Methods

Signature	Description
addEnvironment(key: str, value: str): void	No description

IApp (interface)

No description

Properties

No properties

Methods

Signature	Description
addEnvironment(key: str, value: str): void	No description
getUrl(): str	No description

AppProps (struct)

No description

Properties

Name	Type	Description
buildCommand	str?	No description
buildDir	str?	No description
domain	Domain?	No description
localPort	num?	No description
projectPath	str	No description
startCommand	str?	No description
useBuildCommand	bool?	No description