Class App<T>

This is the smallest available application abstraction in Deepkit.

It is based on a module and executes registered CLI controllers in execute.

@deepkit/framework extends that with a more powerful Application class, that contains also HTTP and RPC controllers.

You can use this class for more integrated unit-tests.

Type Parameters

T extends RootModuleDefinition

Hierarchy

Index

Constructors

constructor

new App<T>(appModuleOptions: T, serviceContainer?: ServiceContainer, appModule?: AppModule<any, any>): App<T>
Type Parameters
- T extends RootModuleDefinition
Parameters
- appModuleOptions: T
- Optional serviceContainer: ServiceContainer
- Optional appModule: AppModule<any, any>
Returns App<T>
- Defined in packages/app/src/app.ts:171

Properties

appModule

appModule: AppModule<T, any>

`Protected` `Optional` envConfigLoader

envConfigLoader?: EnvConfigLoader

`Readonly` serviceContainer

serviceContainer: ServiceContainer

Methods

addConfigLoader

addConfigLoader(loader: ConfigLoader): App<T>
Parameters
- loader: ConfigLoader
Returns App<T>
- Defined in packages/app/src/app.ts:192

configure

configure(config: Partial<ExtractClassType<T["config"]>>): App<T>
Parameters
- config: Partial<ExtractClassType<T["config"]>>
Returns App<T>
- Defined in packages/app/src/app.ts:197

dispatch

dispatch<T>(eventToken: T, event: EventOfEventToken<T>, injector?: InjectorContext): Promise<void>
Type Parameters
- T extends EventToken<any, T>
Parameters
- eventToken: T
- event: EventOfEventToken<T>
- Optional injector: InjectorContext
Returns Promise<void>
- Defined in packages/app/src/app.ts:208

execute

execute(argv: string[], binPaths?: string[]): Promise<number>
Parameters
- argv: string[]
- binPaths: string[] = []
Returns Promise<number>
- Defined in packages/app/src/app.ts:276

get

get<T>(token?: string | number | bigint | boolean | symbol | RegExp | TypeNever | TypeAny | TypeUnknown | TypeVoid | TypeObject | TypeString | TypeNumber | TypeBoolean | TypeBigInt | TypeSymbol | TypeNull | TypeUndefined | TypeLiteral | TypeTemplateLiteral | TypeParameter | TypeFunction | TypeMethod | TypeProperty | TypePromise | TypeClass | TypeEnum | TypeEnumMember | TypeUnion | TypeIntersection | TypeArray | TypeObjectLiteral | TypeIndexSignature | TypePropertySignature | TypeMethodSignature | TypeTypeParameter | TypeInfer | TypeTuple | TypeTupleMember | TypeRest | TypeRegexp | Packed | T | ClassType<T> | AbstractClassType<T>, moduleOrClass?: AppModule<any, any> | ClassType<AppModule<any, any>>): ResolveToken<T>
Type Parameters
- T
Parameters
- Optional token: string | number | bigint | boolean | symbol | RegExp | TypeNever | TypeAny | TypeUnknown | TypeVoid | TypeObject | TypeString | TypeNumber | TypeBoolean | TypeBigInt | TypeSymbol | TypeNull | TypeUndefined | TypeLiteral | TypeTemplateLiteral | TypeParameter | TypeFunction | TypeMethod | TypeProperty | TypePromise | TypeClass | TypeEnum | TypeEnumMember | TypeUnion | TypeIntersection | TypeArray | TypeObjectLiteral | TypeIndexSignature | TypePropertySignature | TypeMethodSignature | TypeTypeParameter | TypeInfer | TypeTuple | TypeTupleMember | TypeRest | TypeRegexp | Packed | T | ClassType<T> | AbstractClassType<T>
- Optional moduleOrClass: AppModule<any, any> | ClassType<AppModule<any, any>>
Returns ResolveToken<T>
- Defined in packages/app/src/app.ts:268

getInjectorContext

getInjectorContext(): InjectorContext
Returns InjectorContext
- Defined in packages/app/src/app.ts:272

listen

listen<T, DEPS>(eventToken: T, callback: EventListenerCallback<T["event"]>, order?: number): App<T>
Type Parameters
- T extends EventToken<any, T>
- DEPS extends any[]
Parameters
- eventToken: T
- callback: EventListenerCallback<T["event"]>
- order: number = 0
Returns App<T>
- Defined in packages/app/src/app.ts:202

loadConfigFromEnv

loadConfigFromEnv(options?: EnvConfigOptions): App<T>
Loads environment variables and optionally reads from .env files in order to find matching configuration options in your application and modules in order to set their values.

Prefixing ENV variables is encouraged to avoid collisions and by default a prefix of APP_ is used Example:

APP_databaseUrl="mongodb://localhost/mydb"

new App({}).loadConfigFromEnvVariables('APP_').run();

envFilePath can be either an absolute or relative path. For relative paths the first folder with a package.json starting from process.cwd() upwards is picked.

So if you use 'local.env' make sure a 'local.env' file is located beside your 'package.json'.

Returns
Parameters
- Optional options: EnvConfigOptions
  
  Configuration options for retrieving configuration from env
Returns App<T>
- Defined in packages/app/src/app.ts:232

loadConfigFromEnvVariable

loadConfigFromEnvVariable(variableName?: string): App<T>
Loads a JSON encoded environment variable and applies its content to the configuration.

Example:

APP_CONFIG={'databaseUrl": "mongodb://localhost/mydb", "moduleA": {"foo": "bar'}}

new App().run().loadConfigFromEnvVariable('APP_CONFIG').run();
Parameters
- variableName: string = 'APP_CONFIG'
Returns App<T>
- Defined in packages/app/src/app.ts:246

run

run(argv?: any[]): Promise<void>
Parameters
- Optional argv: any[]
Returns Promise<void>
- Defined in packages/app/src/app.ts:263

setup

setup(...args: [callback: ((module: AppModule<T, any>, config: any) => void)]): App<T>
Allows to change the module after the configuration has been loaded, right before the application bootstraps.
Parameters
- Rest ...args: [callback: ((module: AppModule<T, any>, config: any) => void)]
Returns App<T>
- Defined in packages/app/src/app.ts:187

`Static` fromModule

fromModule<T>(module: AppModule<T, any>): App<T>
Type Parameters
- T extends RootModuleDefinition
Parameters
- module: AppModule<T, any>
Returns App<T>
- Defined in packages/app/src/app.ts:180

Class App<T>

Type Parameters

T extends RootModuleDefinition

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends RootModuleDefinition

Parameters

appModuleOptions: T

Optional serviceContainer: ServiceContainer

Optional appModule: AppModule<any, any>

Returns App<T>

Properties

appModule

Protected Optional envConfigLoader

Readonly serviceContainer

Methods

addConfigLoader

Parameters

loader: ConfigLoader

Returns App<T>

configure

Parameters

config: Partial<ExtractClassType<T["config"]>>

Returns App<T>

dispatch

Type Parameters

T extends EventToken<any, T>

Parameters

eventToken: T

event: EventOfEventToken<T>

Optional injector: InjectorContext

Returns Promise<void>

execute

Parameters

argv: string[]

binPaths: string[] = []

Returns Promise<number>

get

Type Parameters

T

Parameters

Optional moduleOrClass: AppModule<any, any> | ClassType<AppModule<any, any>>

Returns ResolveToken<T>

getInjectorContext

Returns InjectorContext

listen

Type Parameters

T extends EventToken<any, T>

DEPS extends any[]

Parameters

eventToken: T

callback: EventListenerCallback<T["event"]>

order: number = 0

Returns App<T>

loadConfigFromEnv

Returns

Parameters

Optional options: EnvConfigOptions

Returns App<T>

loadConfigFromEnvVariable

Parameters

variableName: string = 'APP_CONFIG'

Returns App<T>

run

Parameters

Optional argv: any[]

Returns Promise<void>

setup

Parameters

Rest ...args: [callback: ((module: AppModule<T, any>, config: any) => void)]

Returns App<T>

Static fromModule

Type Parameters

T extends RootModuleDefinition

`Optional` serviceContainer: ServiceContainer

`Optional` appModule: AppModule<any, any>

`Protected` `Optional` envConfigLoader

`Readonly` serviceContainer

`Optional` injector: InjectorContext

`Optional` moduleOrClass: AppModule<any, any> | ClassType<AppModule<any, any>>

`Optional` options: EnvConfigOptions

`Optional` argv: any[]

`Rest` ...args: [callback: ((module: AppModule<T, any>, config: any) => void)]

`Static` fromModule