Inherited from ConfigApplication.compile

Compile the application if it is a Typescript application Do nothing otherwise

Returns void
- Defined in packages/core/lib/application.d.ts:358

completeNamespace(name?: string): string

Inherited from ConfigApplication.completeNamespace

Return the full name including namespace

In Webda the ServiceType include namespace Webda/Store or Webda/Test This method will make sure the namespace is present, adding it if no '/' is found in the name

Parameters
- Optional name: string
Returns string
- Defined in packages/core/lib/application.d.ts:386

extends(obj: any, className: any): boolean

Inherited from ConfigApplication.extends

Parameters
- obj: any
- className: any
Returns boolean
- Defined in packages/core/lib/application.d.ts:387

generateModule(): void

Inherited from ConfigApplication.generateModule

Returns void
- Defined in packages/core/lib/application.d.ts:367

getAppPath(subpath?: string): string

Inherited from ConfigApplication.getAppPath

Parameters
- Optional subpath: string
Returns string
- Defined in packages/core/lib/application.d.ts:183

getConfiguration(deploymentName?: string): Configuration

Overrides Application.getConfiguration

Parameters
- Default value deploymentName: string = undefined
Returns Configuration
- Defined in packages/shell/src/handlers/config.ts:71

getCurrentConfiguration(): Configuration

Inherited from ConfigApplication.getCurrentConfiguration

Return current Configuration of the Application
Same as calling
```
getConfiguration(this.currentDeployment);
```
Returns Configuration
- Defined in packages/core/lib/application.d.ts:337

getCurrentDeployment(): string

Inherited from ConfigApplication.getCurrentDeployment

Get current deployment name

Returns string
- Defined in packages/core/lib/application.d.ts:349

getDeployers(): object

Inherited from ConfigApplication.getDeployers

Returns object
- [key: string]: ServiceConstructor<Service>
- Defined in packages/core/lib/application.d.ts:201

getDeployment(deploymentName?: string): Deployment

Inherited from ConfigApplication.getDeployment

Parameters
- Optional deploymentName: string
Returns Deployment
- Defined in packages/core/lib/application.d.ts:214

getGitInformation(): GitInformation

Inherited from ConfigApplication.getGitInformation

Retrieve Git Repository information

GitInformation for more details on how the information is gathered

Returns GitInformation

the git information
- Defined in packages/core/lib/application.d.ts:221

getModel(model: string): any

Overrides Application.getModel

Parameters
- model: string
Returns any
- Defined in packages/shell/src/handlers/config.ts:57

getModels(): object

Inherited from ConfigApplication.getModels

Get all models definitions

Returns object
- [key: string]: Context | CoreModelDefinition
- Defined in packages/core/lib/application.d.ts:198

getModules(): CachedModule

Inherited from ConfigApplication.getModules

Returns CachedModule
- Defined in packages/core/lib/application.d.ts:366

getPackageDescription(): any

Inherited from ConfigApplication.getPackageDescription

Retrieve content of package.json

Returns any
- Defined in packages/core/lib/application.d.ts:160

getPackageWebda(): any

Inherited from ConfigApplication.getPackageWebda

Retrieve specific webda conf from package.json

In case of workspaces the object is combined

Returns any
- Defined in packages/core/lib/application.d.ts:156

getPackagesLocations(): string[]

Inherited from ConfigApplication.getPackagesLocations

Get the application files

Returns string[]
- Defined in packages/core/lib/application.d.ts:396

getService(name: string): ServiceConstructor<Service>

Overrides Application.getService

Parameters
- name: string
Returns ServiceConstructor<Service>
- Defined in packages/shell/src/handlers/config.ts:64

getServices(): object

Inherited from ConfigApplication.getServices

Returns object
- [key: string]: ServiceConstructor<Service<ServiceParameters>>
- Defined in packages/core/lib/application.d.ts:186

getWebdaVersion(): string

Inherited from ConfigApplication.getWebdaVersion

Return webda current version

since

0.4.0

Returns string

package version
- Defined in packages/core/lib/application.d.ts:213

getWorkerOutput(): WorkerOutput

Inherited from ConfigApplication.getWorkerOutput

Returns WorkerOutput
- Defined in packages/core/lib/application.d.ts:182

hasDeployment(deploymentName: string): boolean

Inherited from ConfigApplication.hasDeployment

Parameters
- deploymentName: string
Returns boolean
- Defined in packages/core/lib/application.d.ts:206

isTypescript(): boolean

Inherited from ConfigApplication.isTypescript

Return if the application is a typescript application

Returns boolean
- Defined in packages/core/lib/application.d.ts:353

loadJavascriptFile(absolutePath: string): void

Inherited from ConfigApplication.loadJavascriptFile

Load a javascript file and check for Modda

Parameters
- absolutePath: string
Returns void
- Defined in packages/core/lib/application.d.ts:392

loadLocalModule(): void

Inherited from ConfigApplication.loadLocalModule

Returns void
- Defined in packages/core/lib/application.d.ts:369

loadModules(): void

Inherited from ConfigApplication.loadModules

Load all imported modules and current module It will compile module Generate the current module file Load any imported webda.module.json

Returns void
- Defined in packages/core/lib/application.d.ts:365

loadPackageInfos(): void

Inherited from ConfigApplication.loadPackageInfos

Check package.json

Returns void
- Defined in packages/core/lib/application.d.ts:150

log(level: WorkerLogLevel, ...args: any[]): void

Inherited from ConfigApplication.log

Parameters
- level: WorkerLogLevel
- Rest ...args: any[]
Returns void
- Defined in packages/core/lib/application.d.ts:181

migrateV0Config(config: any): Configuration

Inherited from ConfigApplication.migrateV0Config

Migrate from v0 to v1 configuration

A V0 is a webda.config.json that does not contain any version tag

Parameters
- config: any
Returns Configuration
- Defined in packages/core/lib/application.d.ts:174

migrateV1Config(config: ConfigurationV1): Configuration

Inherited from ConfigApplication.migrateV1Config

Migrate from v1 to v2 configuration format

Parameters
- config: ConfigurationV1
Returns Configuration
- Defined in packages/core/lib/application.d.ts:180

preventCompilation(compile: boolean): void

Inherited from ConfigApplication.preventCompilation

Set the status of the compilation

Parameters
- compile: boolean
  
  true will avoid trigger new compilation
Returns void
- Defined in packages/core/lib/application.d.ts:166

replaceVariables(object: any, replacements?: any): any

Inherited from ConfigApplication.replaceVariables

Allow variable inside object strings
Example
```
replaceVariables({
 myobj: "${test.replace}"
}, {
 test: {
   replace: 'plop'
 }
})
```
will return
```
{
 myobj: 'plop'
}
```
By default the replacements map contains
```
{
 git: GitInformation,
 package: 'package.json content',
 deployment: string,
 now: number,
 ...replacements
}
```
See: GitInformation
Parameters
- object: any
  
  a duplicated object with replacement done
- Optional replacements: any
  
  additional replacements to run
Returns any
- Defined in packages/core/lib/application.d.ts:265

resolveRequire(info: string): any

Inherited from ConfigApplication.resolveRequire

Parameters
- info: string
Returns any
- Defined in packages/core/lib/application.d.ts:368

setCurrentDeployment(deployment: string): void

Inherited from ConfigApplication.setCurrentDeployment

Set the current deployment for the application Call to getCurrentConfiguration will resolve to the computed configuration for the deployment If needed, you can call the method with undefined to reset to default configuration

Parameters
- deployment: string
  
  to set
Returns void
- Defined in packages/core/lib/application.d.ts:345

stringParameter(templateString: string, replacements?: any): any

Inherited from ConfigApplication.stringParameter

Allow variable inside of string

Parameters
- templateString: string
  
  to copy
- Optional replacements: any
  
  additional replacements to run
Returns any
- Defined in packages/core/lib/application.d.ts:228

Generated using TypeDoc

Class ConfigApplication

Hierarchy

Constructors

Properties

Methods

Constructors

Parameters

file: string

Optional logger: WorkerOutput

Returns ConfigApplication

Properties

Type declaration

[key: string]: any

Type declaration

[key: string]: any

Type declaration

[key: string]: ServiceConstructor<Service>

Methods

Parameters

name: string

model: any

Returns void

Parameters

name: string

model: any

Returns void

Parameters

name: string

service: ServiceConstructor<Service>

Returns void

Returns void

Parameters

Optional name: string

Returns string

Parameters

obj: any

className: any

Returns boolean

Returns void

Parameters

Optional subpath: string

Returns string

Parameters

Default value deploymentName: string = undefined

Returns Configuration

Returns Configuration

Returns string

Returns object

[key: string]: ServiceConstructor<Service>

Parameters

Optional deploymentName: string

Returns Deployment

Returns GitInformation

Parameters

model: string

Returns any

Returns object

[key: string]: Context | CoreModelDefinition

Returns CachedModule

Returns any

Returns any

Returns string[]

Parameters

name: string

Returns ServiceConstructor<Service>

Returns object

[key: string]: ServiceConstructor<Service<ServiceParameters>>

Returns string

Returns WorkerOutput

Parameters

deploymentName: string

Returns boolean

Returns boolean

Parameters

absolutePath: string

Returns void

Returns void

Returns void

Returns void

Parameters