MiraDomainApp | Mira - v1.5.0

Main Mira class. Bootstraps CDK and loads in Stacks per user input.

Hierarchy

MiraApp
- MiraDomainApp

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MiraDomainApp(): MiraDomainApp

Overrides MiraApp.constructor
- Defined in src/cdk/domain.ts:16
Returns MiraDomainApp

Properties

cdkApp

cdkApp: App

instance

instance: MiraApp

mainStack

mainStack: MiraStack

serviceStack

serviceStack: MiraServiceStack

stackName

stackName: string

stacks

stacks: MiraStackList = []

Static cliArgs

cliArgs: any = args

Methods

getStack

getStack(fileName: string): Promise<MiraValidStack | boolean>

Inherited from MiraApp.getStack
- Defined in src/cdk/app.ts:64
Load a single stack given the filename

Parameters
- fileName: string
  
  (Optional) Can provide an arbitary name to lookup if name exists in configs.
Returns Promise<MiraValidStack | boolean>

getStacks

getStacks(): Promise<MiraStackList>

Inherited from MiraApp.getStacks
- Defined in src/cdk/app.ts:79
Loads the stacks

Returns Promise<MiraStackList>

initialize

initialize(): Promise<void>

Overrides MiraApp.initialize
- Defined in src/cdk/domain.ts:25
Initializes the app and stack.

Returns Promise<void>

initializeApp

initializeApp(): void

Overrides MiraApp.initializeApp
- Defined in src/cdk/domain.ts:42
Initializes the app. Not much else to see here.

Returns void

Static getBaseStackName

getBaseStackName(suffix?: undefined | string): string

Inherited from MiraApp.getBaseStackName
- Defined in src/cdk/app.ts:101
Parameters
- Optional suffix: undefined | string
Returns string

Static getBaseStackNameFromParams

getBaseStackNameFromParams(prefix: string, name: string, suffix?: undefined | string): string

Inherited from MiraApp.getBaseStackNameFromParams
- Defined in src/cdk/app.ts:105
Parameters
- prefix: string
- name: string
- Optional suffix: undefined | string
Returns string

Static getStackFiles

getStackFiles(): Array<string>

Inherited from MiraApp.getStackFiles
- Defined in src/cdk/app.ts:94
Gets the stack file from CLI.

Returns Array<string>

Static isVerbose

isVerbose(): boolean

Inherited from MiraApp.isVerbose
- Defined in src/cdk/app.ts:170
Returns boolean

Generated using TypeDoc