@loopback/docs
Version:
Documentation for LoopBack 4
1,601 lines (1,600 loc) • 139 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.2.1",
"schemaVersion": 1001,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/core",
"docComment": "",
"name": "@loopback/core",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Function",
"canonicalReference": "(addExtension:0)",
"docComment": "/**\n * Register an extension for the given extension point to the context\n *\n * @param context - Context object\n *\n * @param extensionPointName - Name of the extension point\n *\n * @param extensionClass - Class or a provider for an extension\n *\n * @param options - Options Options for the creation of binding from class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "addExtension"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "context"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "extensionPointName"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "extensionClass"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<unknown>"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "BindingFromClassOptions"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<unknown>"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 20,
"endIndex": 22
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "context",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "extensionPointName",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
},
{
"parameterName": "extensionClass",
"parameterTypeTokenRange": {
"startIndex": 13,
"endIndex": 15
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
}
}
],
"name": "addExtension"
},
{
"kind": "Class",
"canonicalReference": "(Application:class)",
"docComment": "/**\n * Application is the container for various types of artifacts, such as components, servers, controllers, repositories, datasources, connectors, and models.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "Application"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": " "
},
{
"kind": "Content",
"text": "implements "
},
{
"kind": "Reference",
"text": "LifeCycleObserver"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Application",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new instance of the `Application` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ApplicationConfig"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(component:instance,0)",
"docComment": "/**\n * Add a component to this application and register extensions such as controllers, providers, and servers from the component.\n *\n * @param componentCtor - The component class to add.\n *\n * @param name - Optional component name, default to the class name\n *\n * @example\n * ```ts\n *\n * export class ProductComponent {\n * controllers = [ProductController];\n * repositories = [ProductRepo, UserRepo];\n * providers = {\n * [AUTHENTICATION_STRATEGY]: AuthStrategy,\n * [AUTHORIZATION_ROLE]: Role,\n * };\n * };\n *\n * app.component(ProductComponent);\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "component"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "componentCtor"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "componentCtor",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 8
}
},
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 11,
"endIndex": 12
}
}
],
"name": "component"
},
{
"kind": "Method",
"canonicalReference": "(controller:instance,0)",
"docComment": "/**\n * Register a controller class with this application.\n *\n * @param controllerCtor - The controller class (constructor function).\n *\n * @param name - Optional controller name, default to the class name\n *\n * @returns The newly created binding, you can use the reference to further modify the binding, e.g. lock the value to prevent further modifications.\n *\n * @example\n * ```ts\n * class MyController {\n * }\n * app.controller(MyController).lock();\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "controller"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "controllerCtor"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ControllerClass"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "controllerCtor",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "controller"
},
{
"kind": "Method",
"canonicalReference": "(getServer:instance,0)",
"docComment": "/**\n * Retrieve the singleton instance for a bound server.\n *\n * @param ctor - The constructor that was used to make the binding.\n *\n * @typeParam T - Server type\n *\n * @returns A Promise of server instance\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getServer"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Server"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "target"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": "> | string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "getServer"
},
{
"kind": "Method",
"canonicalReference": "(lifeCycleObserver:instance,0)",
"docComment": "/**\n * Register a life cycle observer class\n *\n * @param ctor - A class implements LifeCycleObserver\n *\n * @param name - Optional name for the life cycle observer\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "lifeCycleObserver"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "LifeCycleObserver"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "ctor"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 17,
"endIndex": 21
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "ctor",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 12
}
},
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 15,
"endIndex": 16
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "lifeCycleObserver"
},
{
"kind": "Property",
"canonicalReference": "(options:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ApplicationConfig"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "options",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(server:instance,0)",
"docComment": "/**\n * 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.\n *\n * @param server - The server constructor.\n *\n * @param name - Optional override for key name.\n *\n * @returns Binding for the server class\n *\n * @example\n * ```ts\n * app.server(RestServer);\n * // This server constructor will be bound under \"servers.RestServer\".\n * app.server(RestServer, \"v1API\");\n * // This server instance will be bound under \"servers.v1API\".\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "server"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Server"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "ctor"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 17,
"endIndex": 21
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "ctor",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 12
}
},
{
"parameterName": "name",
"parameterTypeTokenRange": {
"startIndex": 15,
"endIndex": 16
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "server"
},
{
"kind": "Method",
"canonicalReference": "(servers:instance,0)",
"docComment": "/**\n * 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.\n *\n * @remarks\n *\n * If you wish to control the binding keys for particular server instances, use the app.server function instead.\n * ```ts\n * app.servers([\n * RestServer,\n * GRPCServer,\n * ]);\n * // Creates a binding for \"servers.RestServer\" and a binding for\n * // \"servers.GRPCServer\";\n * ```\n *\n * @param ctors - An array of Server constructors.\n *\n * @returns An array of bindings for the registered server classes\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "servers"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "Server"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "ctors"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 13,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "ctors",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 12
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "servers"
},
{
"kind": "Method",
"canonicalReference": "(setMetadata:instance,0)",
"docComment": "/**\n * Set application metadata. `@loopback/boot` calls this method to populate the metadata from `package.json`.\n *\n * @param metadata - Application metadata\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "setMetadata"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "metadata"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "ApplicationMetadata"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "metadata",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "setMetadata"
},
{
"kind": "Method",
"canonicalReference": "(start:instance,0)",
"docComment": "/**\n * Start the application, and all of its registered observers.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "start"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "start"
},
{
"kind": "Method",
"canonicalReference": "(stop:instance,0)",
"docComment": "/**\n * Stop the application instance and all of its registered observers.\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "stop"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Reference",
"text": "Promise"
},
{
"kind": "Content",
"text": "<void>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "stop"
}
],
"extendsTokenRange": {
"startIndex": 3,
"endIndex": 5
},
"implementsTokenRanges": [
{
"startIndex": 6,
"endIndex": 8
}
]
},
{
"kind": "Interface",
"canonicalReference": "(ApplicationConfig:interface)",
"docComment": "/**\n * Configuration for application\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ApplicationConfig"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ApplicationConfig",
"members": [
{
"kind": "IndexSignature",
"canonicalReference": "(:index,0)",
"docComment": "/**\n * Other properties\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "prop"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "]: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "prop",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(ApplicationMetadata:interface)",
"docComment": "/**\n * Type description for `package.json`\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ApplicationMetadata"
},
{
"kind": "Content",
"text": " extends "
},
{
"kind": "Reference",
"text": "JSONObject"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ApplicationMetadata",
"members": [
{
"kind": "PropertySignature",
"canonicalReference": "description",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "description"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "description",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "name",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "name"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "name",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "version",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "version"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "version",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
}
],
"extendsTokenRanges": [
{
"startIndex": 3,
"endIndex": 5
}
]
},
{
"kind": "Function",
"canonicalReference": "(asLifeCycleObserver:0)",
"docComment": "/**\n * A `BindingTemplate` function to configure the binding as life cycle observer by tagging it with `CoreTags.LIFE_CYCLE_OBSERVER`.\n *\n * @param binding - Binding object\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "asLifeCycleObserver"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "binding"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 18
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "binding",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 13
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "asLifeCycleObserver"
},
{
"kind": "Interface",
"canonicalReference": "(ClassMap:interface)",
"docComment": "/**\n * A map of classes to be bound to a context\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "ClassMap"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "ClassMap",
"members": [
{
"kind": "IndexSignature",
"canonicalReference": "(:index,0)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "]: "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "BoundValue"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
}
],
"extendsTokenRanges": []
},
{
"kind": "Interface",
"canonicalReference": "(Component:interface)",
"docComment": "/**\n * A component declares a set of artifacts so that they cane be contributed to an application as a group\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export interface "
},
{
"kind": "Reference",
"text": "Component"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "Component",
"members": [
{
"kind": "IndexSignature",
"canonicalReference": "(:index,0)",
"docComment": "/**\n * Other properties\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "["
},
{
"kind": "Reference",
"text": "prop"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "]: "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "prop",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
]
},
{
"kind": "PropertySignature",
"canonicalReference": "bindings",
"docComment": "/**\n * An array of bindings to be aded to the application context.\n *\n * @example\n * ```ts\n * const bindingX = Binding.bind('x').to('Value X');\n * this.bindings = [bindingX]\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "bindings"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "bindings",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 4
}
},
{
"kind": "PropertySignature",
"canonicalReference": "classes",
"docComment": "/**\n * A map of classes to be bound to the application context.\n *\n * @example\n * ```ts\n * {\n * 'rest.body-parsers.xml': XmlBodyParser\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "classes"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ClassMap"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "classes",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
}
},
{
"kind": "PropertySignature",
"canonicalReference": "controllers",
"docComment": "/**\n * An array of controller classes\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "controllers"
},
{
"kind": "Content",
"text": "?: "
},