Class: application = new Application()

Application is the container for various types of artifacts, such as components, servers, controllers, repositories, datasources, connectors, and models.

Properties

Name	Type	Description
options	`ApplicationConfig`	Application is the container for various types of artifacts, such as components, servers, controllers, repositories, datasources, connectors, and models.

constructor(options: ApplicationConfig) : Application

Arguments

Name	Type	Description
options	`ApplicationConfig`	Application is the container for various types of artifacts, such as components, servers, controllers, repositories, datasources, connectors, and models.

component(componentCtor: Constructor, name: undefined) : void

Add a component to this application and register extensions such as controllers, providers, and servers from the component.

Arguments

Name Type Description

Name	Type	Description
componentCtor	`Constructor`	The component class to add.
name		Optional component name, default to the class name `export class ProductComponent { controllers = [ProductController]; repositories = [ProductRepo, UserRepo]; providers = { [AUTHENTICATION_STRATEGY]: AuthStrategy, [AUTHORIZATION_ROLE]: Role, }; }; app.component(ProductComponent);`

componentCtor

Constructor

The component class to add.

name

Optional component name, default to the class name


export class ProductComponent {
  controllers = [ProductController];
  repositories = [ProductRepo, UserRepo];
  providers = {
    [AUTHENTICATION_STRATEGY]: AuthStrategy,
    [AUTHORIZATION_ROLE]: Role,
  };
};

app.component(ProductComponent);

controller(controllerCtor: ControllerClass, name: undefined) : Binding

Register a controller class with this application.

Returns:

The newly created binding, you can use the reference to further modify the binding, e.g. lock the value to prevent further modifications.

class MyController {
}
app.controller(MyController).lock();

Arguments

Name	Type	Description
controllerCtor	`ControllerClass`	The controller class (constructor function).
name		Optional controller name, default to the class name

getServer(target: undefined) : Promise

Retrieve the singleton instance for a bound constructor.

Arguments

Name	Type	Description
target		Application is the container for various types of artifacts, such as components, servers, controllers, repositories, datasources, connectors, and models.

server(ctor: Constructor, name: undefined) : Binding

Bind a Server constructor to the Application's master context. Each server constructor added in this way must provide a unique prefix to prevent binding overlap.

app.server(RestServer);
// This server constructor will be bound under "servers.RestServer".
app.server(RestServer, "v1API");
// This server instance will be bound under "servers.v1API".

Returns:

Binding for the server class

Arguments

Name	Type	Description
ctor	`Constructor`	Application is the container for various types of artifacts, such as components, servers, controllers, repositories, datasources, connectors, and models.
name		Optional override for key name.

servers(ctors: undefined) :

Bind an array of Server constructors to the Application's master context. Each server added in this way will automatically be named based on the class constructor name with the "servers." prefix.

If you wish to control the binding keys for particular server instances, use the app.server function instead.

app.servers([
 RestServer,
 GRPCServer,
]);
// Creates a binding for "servers.RestServer" and a binding for
// "servers.GRPCServer";

Returns:

An array of bindings for the registered server classes

Arguments

Name	Type	Description
ctors		An array of Server constructors.

start() : Promise

Start the application, and all of its registered servers.

stop() : Promise

Stop the application instance and all of its registered servers.

Interface: ApplicationConfig

Configuration for application

Type alias: ControllerClass = Constructor

Interface: Component

A component declares a set of artifacts so that they cane be contributed to an application as a group

Properties

Name	Type	Description
controllers		An array of controller classes
providers	`ProviderMap`	A map of name/class pairs for binding providers
servers		A map of name/class pairs for servers

Interface: ProviderMap

A map of name/class pairs for binding providers

Function: mountComponent

mountComponent(app: Application, component: Component) : void

Mount a component to an Application.

Arguments

Name	Type	Description
app	`Application`
component	`Component`

Interface: Server

Defines the requirements to implement a Server for LoopBack applications: start() : Promise stop() : Promise It is recommended that each Server implementation creates its own child Context, which inherits from the parent Application context. This way, any Server-specific bindings will remain local to the Server instance, and will avoid polluting its parent module scope.

start() : Promise

Start the server

stop() : Promise

Stop the server