UNPKG

1.41 kBPlain TextView Raw
1// Copyright IBM Corp. and LoopBack contributors 2018,2020. All Rights Reserved.
2// Node module: @loopback/boot
3// This file is licensed under the MIT License.
4// License text available at https://opensource.org/licenses/MIT
5
6/**
7 * A convention based project Bootstrapper and Booters for LoopBack
8 * Applications.
9 *
10 * @remarks
11 * A Booter is a class that can be bound to an Application and is called to
12 * perform a task before the Application is started. A Booter may have multiple
13 * phases to complete its task. The task for a convention based Booter is to
14 * discover and bind Artifacts (Controllers, Repositories, Models, etc.).
15 *
16 * An example task of a Booter may be to discover and bind all artifacts of a
17 * given type.
18 *
19 * A Bootstrapper is needed to manage the Booters and execute them. This is
20 * provided in this package. For ease of use, everything needed is packages
21 * using a BootMixin. This Mixin will add convenience methods such as `boot` and
22 * `booter`, as well as properties needed for Bootstrapper such as
23 * `projectRoot`. The Mixin also adds the `BootComponent` to your `Application`
24 * which binds the `Bootstrapper` and default `Booters` made available by this
25 * package.
26 *
27 * @packageDocumentation
28 */
29
30export * from './boot.component';
31export * from './booters';
32export * from './bootstrapper';
33export * from './keys';
34export * from './mixins';
35export * from './types';