@loopback/docs
Version:
Documentation for LoopBack 4
1,590 lines (1,589 loc) • 590 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.2.1",
"schemaVersion": 1001,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/context",
"docComment": "",
"name": "@loopback/context",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "",
"name": "",
"members": [
{
"kind": "Function",
"canonicalReference": "(asBindingTemplate:0)",
"docComment": "/**\n * Convert binding scope and tags as a template function\n *\n * @param scopeAndTags - Binding scope and tags\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "asBindingTemplate"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "scopeAndTags"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingScopeAndTags"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "BindingTemplate"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "scopeAndTags",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "asBindingTemplate"
},
{
"kind": "Function",
"canonicalReference": "(asClassOrProvider:0)",
"docComment": "/**\n * A factory function to create a template function to bind the target class as a class or `Provider`.\n *\n * @param target - Target class, which can be an implementation of `Provider`\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "asClassOrProvider"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "target"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<unknown>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "BindingTemplate"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
],
"name": "asClassOrProvider"
},
{
"kind": "Function",
"canonicalReference": "(asGlobalInterceptor:0)",
"docComment": "/**\n * The `BindingTemplate` function to configure a binding as a global interceptor by tagging it with `ContextTags.INTERCEPTOR`\n *\n * @param group - Group for ordering the interceptor\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "asGlobalInterceptor"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "group"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "BindingTemplate"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "group",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "asGlobalInterceptor"
},
{
"kind": "Function",
"canonicalReference": "(asProvider:0)",
"docComment": "/**\n * A factory function to create a template function to bind the target class as a `Provider`.\n *\n * @param target - Target provider class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "asProvider"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "target"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Provider"
},
{
"kind": "Content",
"text": "<unknown>>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "BindingTemplate"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
}
],
"name": "asProvider"
},
{
"kind": "Function",
"canonicalReference": "(asResolutionOptions:0)",
"docComment": "/**\n * Normalize ResolutionOptionsOrSession to ResolutionOptions\n *\n * @param optionsOrSession - resolution options or session\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "asResolutionOptions"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "optionsOrSession"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ResolutionOptionsOrSession"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ResolutionOptions"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "optionsOrSession",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "asResolutionOptions"
},
{
"kind": "Function",
"canonicalReference": "(assertTargetType:0)",
"docComment": "/**\n * Assert the target type inspected from TypeScript for injection to be the expected type. If the types don't match, an error is thrown.\n *\n * @param injection - Injection information\n *\n * @param expectedType - Expected type\n *\n * @param expectedTypeName - Name of the expected type to be used in the error\n *\n * @returns The name of the target\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "assertTargetType"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "injection"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Readonly"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Injection"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "expectedType"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Function"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "expectedTypeName"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string | undefined"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 18,
"endIndex": 19
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "injection",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 9
}
},
{
"parameterName": "expectedType",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
},
{
"parameterName": "expectedTypeName",
"parameterTypeTokenRange": {
"startIndex": 16,
"endIndex": 17
}
}
],
"name": "assertTargetType"
},
{
"kind": "Function",
"canonicalReference": "(bind:1)",
"docComment": "/**\n * Decorate a class with binding configuration\n *\n * @param specs - A list of binding scope/tags or template functions to configure the binding\n *\n * @example\n * ```ts\n * @bind((binding) => {binding.inScope(BindingScope.SINGLETON).tag('controller')}\n * )\n * export class MyController {\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare function "
},
{
"kind": "Reference",
"text": "bind"
},
{
"kind": "Content",
"text": "(..."
},
{
"kind": "Reference",
"text": "specs"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingSpec"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ClassDecorator"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "specs",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
],
"name": "bind"
},
{
"kind": "Namespace",
"canonicalReference": "(bind:namespace)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare namespace "
},
{
"kind": "Reference",
"text": "bind"
},
{
"kind": "Content",
"text": " "
}
],
"releaseTag": "Public",
"name": "bind",
"members": [
{
"kind": "Function",
"canonicalReference": "(provider:0)",
"docComment": "/**\n * `@bind.provider` to denote a provider class\n *\n * A list of binding scope/tags or template functions to configure the binding\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "function "
},
{
"kind": "Reference",
"text": "provider"
},
{
"kind": "Content",
"text": "(..."
},
{
"kind": "Reference",
"text": "specs"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingSpec"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "target"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Constructor"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "Provider"
},
{
"kind": "Content",
"text": "<unknown>>) => void"
},
{
"kind": "Content",
"text": ";"
}
],
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "specs",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
],
"name": "provider"
}
]
},
{
"kind": "Class",
"canonicalReference": "(Binding:class)",
"docComment": "/**\n * Binding represents an entry in the `Context`. Each binding has a key and a corresponding value getter.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Reference",
"text": "BoundValue"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "Binding",
"members": [
{
"kind": "Constructor",
"canonicalReference": "(:constructor,0)",
"docComment": "/**\n * Constructs a new instance of the `Binding` class\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingAddress"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "isLocked"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 7
}
},
{
"parameterName": "isLocked",
"parameterTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
}
}
]
},
{
"kind": "Method",
"canonicalReference": "(apply:instance,0)",
"docComment": "/**\n * Apply one or more template functions to set up the binding with scope, tags, and other attributes as a group.\n *\n * @param templateFns - One or more functions to configure the binding\n *\n * @example\n * ```ts\n * const serverTemplate = (binding: Binding) =>\n * binding.inScope(BindingScope.SINGLETON).tag('server');\n *\n * const serverBinding = new Binding<RestServer>('servers.RestServer1');\n * serverBinding.apply(serverTemplate);\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "apply"
},
{
"kind": "Content",
"text": "(..."
},
{
"kind": "Reference",
"text": "templateFns"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingTemplate"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "this"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "templateFns",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 8
}
}
],
"name": "apply"
},
{
"kind": "Method",
"canonicalReference": "(applyDefaultScope:instance,0)",
"docComment": "/**\n * Apply default scope to the binding. It only changes the scope if it's not set yet\n *\n * @param scope - Default binding scope\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "applyDefaultScope"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "scope"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingScope"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "this"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "scope",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "applyDefaultScope"
},
{
"kind": "Method",
"canonicalReference": "(bind:static,0)",
"docComment": "/**\n * A static method to create a binding so that we can do `Binding.bind('foo').to('bar');` as `new Binding('foo').to('bar')` is not easy to read.\n *\n * @param key - Binding key\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "bind"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingAddress"
},
{
"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": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 14,
"endIndex": 18
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 13
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "bind"
},
{
"kind": "Method",
"canonicalReference": "(configure:static,0)",
"docComment": "/**\n * Create a configuration binding for the given key\n *\n * @param key - Key for the binding to be configured\n *\n * @typeparam - T Generic type for the configuration value (not the binding to be configured)\n *\n * @example\n * ```ts\n * const configBinding = Binding.configure('servers.RestServer.server1')\n * .to({port: 3000});\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "static "
},
{
"kind": "Reference",
"text": "configure"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " = "
},
{
"kind": "Content",
"text": "unknown"
},
{
"kind": "Content",
"text": ">("
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingAddress"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Binding"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 11,
"endIndex": 15
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
],
"name": "configure"
},
{
"kind": "Method",
"canonicalReference": "(getValue:instance,1)",
"docComment": "/**\n * This is an internal function optimized for performance. Users should use `@inject(key)` or `ctx.get(key)` instead.\n *\n * Get the value bound to this key. Depending on `isSync`, this function returns either: - the bound value - a promise of the bound value\n *\n * Consumers wishing to consume sync values directly should use `isPromiseLike` to check the type of the returned value to decide how to handle it.\n *\n * @param ctx - Context for the resolution\n *\n * @param session - Optional session for binding and dependency resolution\n *\n * @example\n * ```\n * const result = binding.getValue(ctx);\n * if (isPromiseLike(result)) {\n * result.then(doSomething)\n * } else {\n * doSomething(result);\n * }\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "ctx"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "session"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ResolutionSession"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ValueOrPromise"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "session",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "getValue"
},
{
"kind": "Method",
"canonicalReference": "(getValue:instance,2)",
"docComment": "/**\n * Returns a value or promise for this binding in the given context. The resolved value can be `undefined` if `optional` is set to `true` in `options`.\n *\n * @param ctx - Context for the resolution\n *\n * @param options - Optional options for binding and dependency resolution\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "getValue"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "ctx"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "Context"
},
{
"kind": "Content",
"text": ", "
},
{
"kind": "Reference",
"text": "options"
},
{
"kind": "Content",
"text": "?: "
},
{
"kind": "Reference",
"text": "ResolutionOptions"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ValueOrPromise"
},
{
"kind": "Content",
"text": "<"
},
{
"kind": "Reference",
"text": "T"
},
{
"kind": "Content",
"text": " | undefined>"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 14
},
"releaseTag": "Public",
"overloadIndex": 2,
"parameters": [
{
"parameterName": "ctx",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"name": "getValue"
},
{
"kind": "Method",
"canonicalReference": "(inScope:instance,0)",
"docComment": "/**\n * Set the binding scope\n *\n * @param scope - Binding scope\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "inScope"
},
{
"kind": "Content",
"text": "("
},
{
"kind": "Reference",
"text": "scope"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingScope"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "this"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "scope",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
}
}
],
"name": "inScope"
},
{
"kind": "Property",
"canonicalReference": "(isLocked:instance)",
"docComment": "",
"excerptTokens": [
{
"kind": "Reference",
"text": "isLocked"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "isLocked",
"propertyTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(key:instance)",
"docComment": "/**\n * Key of the binding\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "key"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "key",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(lock:instance,0)",
"docComment": "/**\n * Lock the binding so that it cannot be rebound\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "lock"
},
{
"kind": "Content",
"text": "(): "
},
{
"kind": "Content",
"text": "this"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 2,
"endIndex": 3
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [],
"name": "lock"
},
{
"kind": "Property",
"canonicalReference": "(scope:instance)",
"docComment": "/**\n * Scope of the binding to control how the value is cached/shared\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "scope"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingScope"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "scope",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(tag:instance,0)",
"docComment": "/**\n * Tag the binding with names or name/value objects. A tag has a name and an optional value. If not supplied, the tag name is used as the value.\n *\n * @param tags - A list of names or name/value objects. Each parameter can be in one of the following forms: - string: A tag name without value - string[]: An array of tag names - TagMap: A map of tag name/value pairs\n *\n * @example\n * ```ts\n * // Add a named tag `controller`\n * binding.tag('controller');\n *\n * // Add two named tags: `controller` and `rest`\n * binding.tag('controller', 'rest');\n *\n * // Add two tags\n * // - `controller` (name = 'controller')\n * // `{name: 'my-controller'}` (name = 'name', value = 'my-controller')\n * binding.tag('controller', {name: 'my-controller'});\n *\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "tag"
},
{
"kind": "Content",
"text": "(..."
},
{
"kind": "Reference",
"text": "tags"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "BindingTag"
},
{
"kind": "Content",
"text": "[]"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "this"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"releaseTag": "Public",
"overloadIndex": 0,
"parameters": [
{
"parameterName": "tags",
"parameterTypeTokenRange": {
"startIndex": 4,
"endIndex": 6
}
}
],
"name": "tag"
},
{
"kind": "Property",
"canonicalReference": "(tagMap:instance)",
"docComment": "/**\n * Map for tag name/value pairs\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "tagMap"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Reference",
"text": "TagMap"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "tagMap",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Property",
"canonicalReference": "(tagNames:instance)",
"docComment": "/**\n * Get an array of tag names\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "readonly "
},
{
"kind": "Reference",
"text": "tagNames"
},
{
"kind": "Content",
"text": ": "
},
{
"kind": "Content",
"text": "string[]"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "tagNames",
"propertyTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "(to:instance,0)",
"docComment": "/**\n * Bind the key to a constant value. The value must be already available at binding time, it is not allowed to pass a Promise instance.\n *\n * @param value - The bound value.\n *\n * @example\n * ```ts\n * ctx.bind('appName').to('CodeHub');\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Reference",
"text": "to"
},
{
"kind": "Content",
"text": "("
},
{