Package Exports

@loopback/boot

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@loopback/boot) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@loopback/boot

A convention based project Bootstrapper and Booters for LoopBack Applications

Overview

A Booter is a Class that can be bound to an Application and is called to perform a task before the Application is started. A Booter may have multiple phases to complete its task.

An example task of a Booter may be to discover and bind all artifacts of a given type.

A Bootstrapper is needed to manage the Booters and execute them. This is provided in this package. For ease of use, everything needed is packages using a BootMixin. This Mixin will add convenience methods such as boot and booter, as well as properties needed for Bootstrapper such as projectRoot. The Mixin also adds the BootComponent to your Application which binds the Bootstrapper and default Booters made available by this package.

Installation

$ npm i @loopback/boot

Basic Use

import {Application} from '@loopback/core';
import {BootMixin} from '@loopback/boot';
class BootApp extends BootMixin(Application) {}

const app = new BootApp();
app.projectRoot = __dirname;
app.bootOptions = {
  controlles: {
    // Configure ControllerBooter Conventiones here.
  }
}

await app.boot();
await app.start();

BootOptions

List of Options available on BootOptions Object.

Option	Type	Description
`controllers`	`ArtifactOptions`	ControllerBooter convention options

ArtifactOptions

Add Table for ArtifactOptions

BootExecOptions

Add Table for BootExecOptions

Available Booters

ControllerBooter

Description

Discovers and binds Controller Classes using app.controller().

Options

The Options for this can be passed via BootOptions when calling app.boot(options:BootOptions).

The options for this are passed in a controllers object on BootOptions.

Available Options on the controllers object on BootOptions are as follows:

Options	Type	Default	Description
`dirs`	`string	string[]`	`['controllers']`
`extensions`	`string	string[]`	`['.controller.js']`
`nested`	`boolean`	`true`	Look in nested directories in `dirs` for Controller artifacts
`glob`	`string`		A `glob` pattern string. This takes precendence over above 3 options (which are used to make a glob pattern).

Contributions

Tests

Run npm test from the root folder.

Contributors

See all contributors.

License

MIT