UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

87 lines (66 loc) 3.3 kB
--- lang: en title: 'Components' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Concepts sidebar: lb4_sidebar permalink: /doc/en/lb4/Components.html --- ## Overview Components play an important role in the extensibility of LoopBack 4. A Component makes it easy for independent developers to contribute additional features to LoopBack. Components serve as a vehicle to group extension contributions such as [Context Bindings](Context.md) and various artifacts to allow easier extensibility of your Application. A typical LoopBack component is an [npm](https://www.npmjs.com) package exporting a Component class which can be added to your application. Apart from its own properties, `Component` class can have the following properties: - `controllers` - An array of [controller](Controllers.md) classes. - `providers` - A map of providers to be bound to the application [context](Context.md). - `classes` - A map of TypeScript classes to be bound to the application context. - `servers` - A map of name/class pairs for [servers](Server.md). - `lifeCycleObservers` - An array of [life cycle observers](Life-cycle.md). - `services` - An array of [service](Services.md) classes or providers. - `bindings` - An array of [bindings](Binding.md) to be added to the application context. A good example of using bindings to extend the functionality of a LoopBack 4 app is [contributing an additional body parser](Extending-request-body-parsing.html#contribute-a-body-parser-from-a-component). These properties contribute to the application to add additional features and capabilities. LoopBack 4 was built with extensibility in mind and this includes Components, which can be allowed to contribute additional artifacts by adding a Mixin to your Application class. This doesn't change how a Component is registered (`app.component()`) but it enables the Component to contribute additional artifacts. For example: - [Repositories](Repositories.md) can be contributed by a Component by adding `RepositoryMixin` from `@loopback/repository` to your Application - [Booters](Booting-an-Application.md#booters) can be contributed by a Component by adding `BootMixin` from `@loopback/boot` to your Application ![Components](imgs/loopback-component.png) {% include note.html content=" Always check a component's instructions to see if it requires the use of a Mixin. A Mixin may automatically register a Component, saving you the trouble of having to do so manually. Again it's best to check the documentation for the given Component/Mixin. " %} ## Using components Components can be added to your application using the `app.component()` method. The following is an example of installing and using a component. Install the following dependencies: ```sh npm install --save @loopback/authentication ``` To load the component in your application: ```ts import {RestApplication} from '@loopback/rest'; import {AuthenticationComponent} from '@loopback/authentication'; const app = new RestApplication(); // Add component to Application, which provides bindings used to resolve // authenticated requests in a Sequence. app.component(AuthenticationComponent); ``` ## Creating components Please refer to [Creating components](Creating-components.md) for more information.