@loopback/docs
Version:
Documentation for LoopBack 4
1,390 lines • 112 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.6.2",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/boot!",
"docComment": "",
"name": "@loopback/boot",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/boot!",
"name": "",
"members": [
{
"kind": "Function",
"canonicalReference": "@loopback/boot!_bindBooter:function(1)",
"docComment": "/**\n * Method which binds a given Booter to a given Context with the Prefix and Tags expected by the Bootstrapper\n *\n * @param ctx - The Context to bind the Booter Class\n *\n * @param booterCls - Booter class to be bound\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function _bindBooter(ctx: "
},
{
"kind": "Reference",
"text": "Context",
"canonicalReference": "@loopback/context!Context:class"
},
{
"kind": "Content",
"text": ", booterCls: "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Booter",
"canonicalReference": "@loopback/boot!Booter:interface"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding",
"canonicalReference": "@loopback/context!Binding:class"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "booterCls",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
}
}
],
"name": "_bindBooter"
},
{
"kind": "Class",
"canonicalReference": "@loopback/boot!ApplicationMetadataBooter:class",
"docComment": "/**\n * Configure the application with metadata from `package.json`\n *\n * @param app - Application instance\n *\n * @param projectRoot - Root of User Project\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ApplicationMetadataBooter implements "
},
{
"kind": "Reference",
"text": "Booter",
"canonicalReference": "@loopback/boot!Booter:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ApplicationMetadataBooter",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/boot!ApplicationMetadataBooter:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `ApplicationMetadataBooter` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(app: "
},
{
"kind": "Reference",
"text": "Application",
"canonicalReference": "@loopback/core!Application:class"
},
{
"kind": "Content",
"text": ", projectRoot: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "app",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "projectRoot",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!ApplicationMetadataBooter#app:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "app: "
},
{
"kind": "Reference",
"text": "Application",
"canonicalReference": "@loopback/core!Application:class"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "app",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "@loopback/boot!ApplicationMetadataBooter#configure:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "configure(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "configure"
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/boot!ArtifactOptions:type",
"docComment": "/**\n * Type definition for ArtifactOptions. These are the options supported by this Booter.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type ArtifactOptions = "
},
{
"kind": "Content",
"text": "{\n dirs?: string | string[];\n extensions?: string | string[];\n nested?: boolean;\n glob?: string;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "ArtifactOptions",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Class",
"canonicalReference": "@loopback/boot!BaseArtifactBooter:class",
"docComment": "/**\n * This class serves as a base class for Booters which follow a pattern of configure, discover files in a folder(s) using explicit folder / extensions or a glob pattern and lastly identifying exported classes from such files and performing an action on such files such as binding them.\n *\n * Any Booter extending this base class is expected to\n *\n * 1. Set the 'options' property to a object of ArtifactOptions type. (Each extending class should provide defaults for the ArtifactOptions and use Object.assign to merge the properties with user provided Options). 2. Provide it's own logic for 'load' after calling 'await super.load()' to actually boot the Artifact classes.\n *\n * Currently supports the following boot phases: configure, discover, load.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class BaseArtifactBooter implements "
},
{
"kind": "Reference",
"text": "Booter",
"canonicalReference": "@loopback/boot!Booter:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "BaseArtifactBooter",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/boot!BaseArtifactBooter:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `BaseArtifactBooter` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(projectRoot: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", options: "
},
{
"kind": "Reference",
"text": "ArtifactOptions",
"canonicalReference": "@loopback/boot!ArtifactOptions:type"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "projectRoot",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#classes:member",
"docComment": "/**\n * List of exported classes discovered in the files\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "classes: "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<{}>[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "classes",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#configure:member(1)",
"docComment": "/**\n * Configure the Booter by initializing the 'dirs', 'extensions' and 'glob' properties.\n *\n * NOTE: All properties are configured even if all aren't used.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "configure(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "configure"
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#dirs:member",
"docComment": "/**\n * Relative paths of directories to be searched\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "dirs: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "dirs",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#discover:member(1)",
"docComment": "/**\n * Discover files based on the 'glob' property relative to the 'projectRoot'. Discovered artifact files matching the pattern are saved to the 'discovered' property.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "discover(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "discover"
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#discovered:member",
"docComment": "/**\n * List of files discovered by the Booter that matched artifact requirements\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "discovered: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "discovered",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#extensions:member",
"docComment": "/**\n * File extensions to be searched\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "extensions: "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "extensions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#glob:member",
"docComment": "/**\n * `glob` pattern to match artifact paths\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "glob: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "glob",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#load:member(1)",
"docComment": "/**\n * Filters the exports of 'discovered' files to only be Classes (in case function / types are exported) as an artifact is a Class. The filtered artifact Classes are saved in the 'classes' property.\n *\n * NOTE: Booters extending this class should call this method (await super.load()) and then process the artifact classes as appropriate.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "load(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "load"
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#options:member",
"docComment": "/**\n * Options being used by the Booter.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly options: "
},
{
"kind": "Reference",
"text": "ArtifactOptions",
"canonicalReference": "@loopback/boot!ArtifactOptions:type"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "options",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BaseArtifactBooter#projectRoot:member",
"docComment": "/**\n * Project root relative to which all other paths are resolved\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly projectRoot: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "projectRoot",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "Interface",
"canonicalReference": "@loopback/boot!Bootable:interface",
"docComment": "/**\n * Interface to describe the additions made available to an Application that uses BootMixin.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Bootable "
}
],
"releaseTag": "Public",
"name": "Bootable",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "@loopback/boot!Bootable#boot:member(1)",
"docComment": "/**\n * Boot up the project\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "boot(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "boot"
},
{
"kind": "MethodSignature",
"canonicalReference": "@loopback/boot!Bootable#booters:member(1)",
"docComment": "/**\n * Register booters\n *\n * @param booterClasses - A list of booter classes\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "booters(...booterClasses: "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Booter",
"canonicalReference": "@loopback/boot!Booter:interface"
},
{
"kind": "Content",
"text": ">[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding",
"canonicalReference": "@loopback/context!Binding:class"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "booterClasses",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
}
],
"name": "booters"
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/boot!Bootable#bootOptions:member",
"docComment": "/**\n * Options for boot\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "bootOptions?: "
},
{
"kind": "Reference",
"text": "BootOptions",
"canonicalReference": "@loopback/boot!BootOptions:type"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bootOptions",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "PropertySignature",
"canonicalReference": "@loopback/boot!Bootable#projectRoot:member",
"docComment": "/**\n * Root directory for the project to be booted\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "projectRoot: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "projectRoot",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"extendsTokenRanges": []
},
{
"kind": "Namespace",
"canonicalReference": "@loopback/boot!BootBindings:namespace",
"docComment": "/**\n * Namespace for boot related binding keys\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace BootBindings "
}
],
"releaseTag": "Public",
"name": "BootBindings",
"members": [
{
"kind": "Variable",
"canonicalReference": "@loopback/boot!BootBindings.BOOT_OPTIONS:var",
"docComment": "/**\n * Binding key for boot options\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "BOOT_OPTIONS: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "BootOptions",
"canonicalReference": "@loopback/boot!BootOptions:type"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "BOOT_OPTIONS",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/boot!BootBindings.BOOTER_PREFIX:var",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "BOOTER_PREFIX = \"booters\""
}
],
"releaseTag": "Public",
"name": "BOOTER_PREFIX",
"variableTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/boot!BootBindings.BOOTSTRAPPER_KEY:var",
"docComment": "/**\n * Binding key for binding the BootStrapper class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "BOOTSTRAPPER_KEY: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Bootstrapper",
"canonicalReference": "@loopback/boot!Bootstrapper:class"
},
{
"kind": "Content",
"text": ">"
}
],
"releaseTag": "Public",
"name": "BOOTSTRAPPER_KEY",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"kind": "Variable",
"canonicalReference": "@loopback/boot!BootBindings.PROJECT_ROOT:var",
"docComment": "/**\n * Binding key for determining project root directory\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "PROJECT_ROOT: "
},
{
"kind": "Reference",
"text": "BindingKey",
"canonicalReference": "@loopback/context!BindingKey:class"
},
{
"kind": "Content",
"text": "<string>"
}
],
"releaseTag": "Public",
"name": "PROJECT_ROOT",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
]
},
{
"kind": "Class",
"canonicalReference": "@loopback/boot!BootComponent:class",
"docComment": "/**\n * BootComponent is used to export the default list of Booter's made available by this module as well as bind the BootStrapper to the app so it can be used to run the Booters.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class BootComponent implements "
},
{
"kind": "Reference",
"text": "Component",
"canonicalReference": "@loopback/core!Component:interface"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "BootComponent",
"members": [
{
"kind": "Constructor",
"canonicalReference": "@loopback/boot!BootComponent:constructor(1)",
"docComment": "/**\n * Constructs a new instance of the `BootComponent` class\n *\n * @param app - Application instance\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(app: "
},
{
"kind": "Reference",
"text": "Application",
"canonicalReference": "@loopback/core!Application:class"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "app",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
]
},
{
"kind": "Property",
"canonicalReference": "@loopback/boot!BootComponent#booters:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "booters: "
},
{
"kind": "Content",
"text": "(typeof "
},
{
"kind": "Reference",
"text": "ApplicationMetadataBooter",
"canonicalReference": "@loopback/boot!ApplicationMetadataBooter:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "ControllerBooter",
"canonicalReference": "@loopback/boot!ControllerBooter:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "DataSourceBooter",
"canonicalReference": "@loopback/boot!DataSourceBooter:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "InterceptorProviderBooter",
"canonicalReference": "@loopback/boot!InterceptorProviderBooter:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "LifeCycleObserverBooter",
"canonicalReference": "@loopback/boot!LifeCycleObserverBooter:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "RepositoryBooter",
"canonicalReference": "@loopback/boot!RepositoryBooter:class"
},
{
"kind": "Content",
"text": " | typeof "
},
{
"kind": "Reference",
"text": "ServiceBooter",
"canonicalReference": "@loopback/boot!ServiceBooter:class"
},
{
"kind": "Content",
"text": ")[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "booters",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 16
},
"isStatic": false
}
],
"implementsTokenRanges": [
{
"startIndex": 1,
"endIndex": 3
}
]
},
{
"kind": "Variable",
"canonicalReference": "@loopback/boot!BOOTER_PHASES:var",
"docComment": "/**\n * Export of an array of all the Booter phases supported by the interface above, in the order they should be run.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "BOOTER_PHASES: "
},
{
"kind": "Content",
"text": "string[]"
}
],
"releaseTag": "Public",
"name": "BOOTER_PHASES",
"variableTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"kind": "Function",
"canonicalReference": "@loopback/boot!booter:function(1)",
"docComment": "/**\n * `@booter` decorator to mark a class as a `Booter` and specify the artifact namespace for the configuration of the booter\n *\n * @param artifactNamespace - Namespace for the artifact. It will be used to inject configuration from boot options. For example, the Booter class decorated with `@booter('controllers')` can receive its configuration via `@config()` from the `controllers` property of boot options.\n *\n * @param specs - Extra specs for the binding\n *\n * @example\n * ```ts\n * @booter('controllers')\n * export class ControllerBooter extends BaseArtifactBooter {\n * constructor(\n * @inject(CoreBindings.APPLICATION_INSTANCE) public app: Application,\n * @inject(BootBindings.PROJECT_ROOT) projectRoot: string,\n * @config()\n * public controllerConfig: ArtifactOptions = {},\n * ) {\n * // ...\n * }\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function booter(artifactNamespace: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", ...specs: "
},
{
"kind": "Reference",
"text": "BindingSpec",
"canonicalReference": "@loopback/context!BindingSpec:type"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ClassDecorator",
"canonicalReference": "!ClassDecorator:type"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "artifactNamespace",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "specs",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 5
}
}
],
"name": "booter"
},
{
"kind": "Interface",
"canonicalReference": "@loopback/boot!Booter:interface",
"docComment": "/**\n * Defines the requirements to implement a Booter for LoopBack applications: - configure() - discover() - load()\n *\n * A Booter will run through the above methods in order.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface Booter "
}
],
"releaseTag": "Public",
"name": "Booter",
"members": [
{
"kind": "MethodSignature",
"canonicalReference": "@loopback/boot!Booter#configure:member(1)",
"docComment": "/**\n * Configure phase of the Booter. It should set options / defaults in this phase.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "configure?(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "configure"
},
{
"kind": "MethodSignature",
"canonicalReference": "@loopback/boot!Booter#discover:member(1)",
"docComment": "/**\n * Discover phase of the Booter. It should search for artifacts in this phase.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "discover?(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "discover"
},
{
"kind": "MethodSignature",
"canonicalReference": "@loopback/boot!Booter#load:member(1)",
"docComment": "/**\n * Load phase of the Booter. It should bind the artifacts in this phase.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "load?(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "load"
}
],
"extendsTokenRanges": []
},
{
"kind": "TypeAlias",
"canonicalReference": "@loopback/boot!BootExecutionOptions:type",
"docComment": "/**\n * Options for boot() execution\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare type BootExecutionOptions = "
},
{
"kind": "Content",
"text": "{\n booters?: "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Booter",
"canonicalReference": "@loopback/boot!Booter:interface"
},
{
"kind": "Content",
"text": ">[];\n filter?: {\n booters?: string[];\n phases?: string[];\n };\n [prop: string]: any;\n}"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "BootExecutionOptions",
"typeTokenRange": {
"startIndex": 1,
"endIndex": 6
}
},
{
"kind": "Function",
"canonicalReference": "@loopback/boot!BootMixin:function(1)",
"docComment": "/**\n * Mixin for @loopback/boot. This Mixin provides the following: - Implements the Bootable Interface as follows. - Add a `projectRoot` property to the Class - Adds an optional `bootOptions` property to the Class that can be used to store the Booter conventions. - Adds the `BootComponent` to the Class (which binds the Bootstrapper and default Booters) - Provides the `boot()` convenience method to call Bootstrapper.boot() - Provides the `booter()` convenience method to bind a Booter(s) to the Application - Override `component()` to call `mountComponentBooters` - Adds `mountComponentBooters` which binds Booters to the application from `component.booters[]`\n *\n * ******************** NOTE ******************** Trying to constrain the type of this Mixin (or any Mixin) will cause errors. For example, constraining this Mixin to type Application require all types using by Application to be imported (including it's dependencies such as ResolutionSession). Another issue was that if a Mixin that is type constrained is used with another Mixin that is not, it will result in an error. Example (class MyApp extends BootMixin(RepositoryMixin(Application))) {}; ******************** END OF NOTE ********************\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function BootMixin<T extends "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<any>"
},
{
"kind": "Content",
"text": ">(superClass: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "{\n new (...args: any[]): {\n [x: string]: any;\n projectRoot: string;\n bootOptions?: "
},
{
"kind": "Reference",
"text": "BootOptions",
"canonicalReference": "@loopback/boot!BootOptions:type"
},
{
"kind": "Content",
"text": " | undefined;\n boot(): "
},
{
"kind": "Reference",
"text": "Promise",
"canonicalReference": "!Promise:interface"
},
{
"kind": "Content",
"text": "<void>;\n booters(...booterCls: "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Booter",
"canonicalReference": "@loopback/boot!Booter:interface"
},
{
"kind": "Content",
"text": ">[]): "
},
{
"kind": "Reference",
"text": "Binding",
"canonicalReference": "@loopback/context!Binding:class"
},
{
"kind": "Content",
"text": "<any>[];\n component(component: "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<{}>): void;\n mountComponentBooters(component: "
},
{
"kind": "Reference",
"text": "Constructor",
"canonicalReference": "@loopback/context!Constructor:type"
},
{
"kind": "Content",
"text": "<{}>):