@loopback/docs
Version:
Documentation for LoopBack 4
1,426 lines (1,425 loc) • 201 kB
JSON
{
"metadata": {
"toolPackage": "@microsoft/api-extractor",
"toolVersion": "7.6.2",
"schemaVersion": 1003,
"oldestForwardsCompatibleVersion": 1001
},
"kind": "Package",
"canonicalReference": "@loopback/metadata!",
"docComment": "",
"name": "@loopback/metadata",
"members": [
{
"kind": "EntryPoint",
"canonicalReference": "@loopback/metadata!",
"name": "",
"members": [
{
"kind": "Class",
"canonicalReference": "@loopback/metadata!ClassDecoratorFactory:class",
"docComment": "/**\n * Factory for class decorators\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class ClassDecoratorFactory<T> extends "
},
{
"kind": "Reference",
"text": "DecoratorFactory",
"canonicalReference": "@loopback/metadata!DecoratorFactory:class"
},
{
"kind": "Content",
"text": "<T, T, "
},
{
"kind": "Reference",
"text": "ClassDecorator",
"canonicalReference": "!ClassDecorator:type"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "ClassDecoratorFactory",
"members": [
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!ClassDecoratorFactory#create:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "create(): "
},
{
"kind": "Reference",
"text": "ClassDecorator",
"canonicalReference": "!ClassDecorator:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "create"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!ClassDecoratorFactory.createDecorator:member(1)",
"docComment": "/**\n * Create a class decorator function\n *\n * @param key - Metadata key\n *\n * @param spec - Metadata object from the decorator function\n *\n * @param options - Options for the decorator\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "static createDecorator<T>(key: "
},
{
"kind": "Reference",
"text": "MetadataKey",
"canonicalReference": "@loopback/metadata!MetadataKey:type"
},
{
"kind": "Content",
"text": "<T, "
},
{
"kind": "Reference",
"text": "ClassDecorator",
"canonicalReference": "!ClassDecorator:type"
},
{
"kind": "Content",
"text": ">"
},
{
"kind": "Content",
"text": ", spec: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "DecoratorOptions",
"canonicalReference": "@loopback/metadata!DecoratorOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "ClassDecorator",
"canonicalReference": "!ClassDecorator:type"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 5
}
},
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 6,
"endIndex": 7
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "createDecorator"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!ClassDecoratorFactory#mergeWithInherited:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected mergeWithInherited(inheritedMetadata: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ", target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", descriptorOrIndex?: "
},
{
"kind": "Reference",
"text": "TypedPropertyDescriptor",
"canonicalReference": "!TypedPropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "<any> | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "inheritedMetadata",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "descriptorOrIndex",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"name": "mergeWithInherited"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!ClassDecoratorFactory#mergeWithOwn:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected mergeWithOwn(ownMetadata: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ", target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", descriptorOrIndex?: "
},
{
"kind": "Reference",
"text": "TypedPropertyDescriptor",
"canonicalReference": "!TypedPropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "<any> | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "ownMetadata",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "descriptorOrIndex",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"name": "mergeWithOwn"
}
],
"extendsTokenRange": {
"startIndex": 1,
"endIndex": 5
},
"implementsTokenRanges": []
},
{
"kind": "Class",
"canonicalReference": "@loopback/metadata!DecoratorFactory:class",
"docComment": "/**\n * Base factory class for decorator functions\n *\n * @example\n * ```\n * function classDecorator(spec: MySpec): ClassDecorator {\n * return ClassDecoratorFactory.createDecorator('my-key', spec);\n * }\n * ```\n *\n * or\n * ```\n * function classDecorator(spec: MySpec): ClassDecorator {\n * const factory: ClassDecoratorFactory<MySpec>('my-key', spec);\n * return factory.create();\n * }\n * ```\n *\n * These functions above declare `@classDecorator` that can be used as follows:\n * ```\n * @classDecorator({x: 1})\n * class MyController {}\n * ```\n *\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare class DecoratorFactory<T, // Type of the metadata spec for individual class/method/property/parameter\nM extends "
},
{
"kind": "Content",
"text": "T | "
},
{
"kind": "Reference",
"text": "MetadataMap",
"canonicalReference": "@loopback/metadata!MetadataMap:interface"
},
{
"kind": "Content",
"text": "<T> | "
},
{
"kind": "Reference",
"text": "MetadataMap",
"canonicalReference": "@loopback/metadata!MetadataMap:interface"
},
{
"kind": "Content",
"text": "<T[]>"
},
{
"kind": "Content",
"text": ", // Type of the metadata\nD extends "
},
{
"kind": "Reference",
"text": "DecoratorType",
"canonicalReference": "@loopback/metadata!DecoratorType:type"
},
{
"kind": "Content",
"text": "> "
}
],
"releaseTag": "Public",
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "M",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "D",
"constraintTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "DecoratorFactory",
"members": [
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory._createDecorator:member(1)",
"docComment": "/**\n * Create a decorator function\n *\n * @param key - Metadata key\n *\n * @param spec - Metadata object from the decorator function\n *\n * @param options - Options for the decorator\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected static _createDecorator<T, M extends "
},
{
"kind": "Content",
"text": "T | "
},
{
"kind": "Reference",
"text": "MetadataMap",
"canonicalReference": "@loopback/metadata!MetadataMap:interface"
},
{
"kind": "Content",
"text": "<T> | "
},
{
"kind": "Reference",
"text": "MetadataMap",
"canonicalReference": "@loopback/metadata!MetadataMap:interface"
},
{
"kind": "Content",
"text": "<T[]>"
},
{
"kind": "Content",
"text": ", D extends "
},
{
"kind": "Reference",
"text": "DecoratorType",
"canonicalReference": "@loopback/metadata!DecoratorType:type"
},
{
"kind": "Content",
"text": ">(key: "
},
{
"kind": "Reference",
"text": "MetadataKey",
"canonicalReference": "@loopback/metadata!MetadataKey:type"
},
{
"kind": "Content",
"text": "<T, D>"
},
{
"kind": "Content",
"text": ", spec: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "DecoratorOptions",
"canonicalReference": "@loopback/metadata!DecoratorOptions:interface"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "D"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 16,
"endIndex": 17
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 9,
"endIndex": 11
}
},
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 12,
"endIndex": 13
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 14,
"endIndex": 15
}
}
],
"typeParameters": [
{
"typeParameterName": "T",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "M",
"constraintTokenRange": {
"startIndex": 1,
"endIndex": 6
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
},
{
"typeParameterName": "D",
"constraintTokenRange": {
"startIndex": 7,
"endIndex": 8
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "_createDecorator"
},
{
"kind": "Constructor",
"canonicalReference": "@loopback/metadata!DecoratorFactory:constructor(1)",
"docComment": "/**\n * Construct a new class decorator factory\n *\n * @param key - Metadata key\n *\n * @param spec - Metadata object from the decorator function\n *\n * @param options - Options for the decorator. Default to `{allowInheritance: true}` if not provided\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "constructor(key: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", spec: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ", options?: "
},
{
"kind": "Reference",
"text": "DecoratorOptions",
"canonicalReference": "@loopback/metadata!DecoratorOptions:interface"
},
{
"kind": "Content",
"text": ");"
}
],
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "key",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "options",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
}
]
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#allowInheritance:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected allowInheritance(): "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "allowInheritance"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory.cloneDeep:member(1)",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "static cloneDeep<V>(val: "
},
{
"kind": "Reference",
"text": "Readonly",
"canonicalReference": "!Readonly:type"
},
{
"kind": "Content",
"text": "<V>"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "V"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 4,
"endIndex": 5
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "val",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 3
}
}
],
"typeParameters": [
{
"typeParameterName": "V",
"constraintTokenRange": {
"startIndex": 0,
"endIndex": 0
},
"defaultTypeTokenRange": {
"startIndex": 0,
"endIndex": 0
}
}
],
"name": "cloneDeep"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#create:member(1)",
"docComment": "/**\n * Create a decorator function of the given type. Each sub class MUST implement this method.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "create(): "
},
{
"kind": "Content",
"text": "D"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [],
"name": "create"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#decorate:member(1)",
"docComment": "/**\n * Base implementation of the decorator function\n *\n * @param target - Decorator target\n *\n * @param member - Optional property or method\n *\n * @param descriptorOrIndex - Optional method descriptor or parameter index\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected decorate(target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string | symbol"
},
{
"kind": "Content",
"text": ", descriptorOrIndex?: "
},
{
"kind": "Reference",
"text": "TypedPropertyDescriptor",
"canonicalReference": "!TypedPropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "<any> | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "descriptorOrIndex",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
],
"name": "decorate"
},
{
"kind": "Property",
"canonicalReference": "@loopback/metadata!DecoratorFactory#decoratorName:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected decoratorName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "decoratorName",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#duplicateDecorationError:member(1)",
"docComment": "/**\n * Create an error to report if the decorator is applied to the target more than once\n *\n * @param target - Decoration target\n *\n * @param member - Optional property or method\n *\n * @param descriptorOrIndex - Optional parameter index or method descriptor\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected duplicateDecorationError(target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string | symbol"
},
{
"kind": "Content",
"text": ", descriptorOrIndex?: "
},
{
"kind": "Reference",
"text": "TypedPropertyDescriptor",
"canonicalReference": "!TypedPropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "<any> | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Reference",
"text": "Error",
"canonicalReference": "!Error:interface"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "descriptorOrIndex",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
],
"name": "duplicateDecorationError"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory.getNumberOfParameters:member(1)",
"docComment": "/**\n * Get the number of parameters for a given constructor or method\n *\n * @param target - Class or the prototype\n *\n * @param member - Method name\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "static getNumberOfParameters(target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "getNumberOfParameters"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#getTarget:member(1)",
"docComment": "/**\n * Get the optional decoration target of a given spec\n *\n * @param spec - Metadata spec\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "getTarget(spec: "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "any"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "spec",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "getTarget"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory.getTargetName:member(1)",
"docComment": "/**\n * Get the qualified name of a decoration target. For example:\n * ```\n * class MyClass\n * MyClass.constructor[0] // First parameter of the constructor\n * MyClass.myStaticProperty\n * MyClass.myStaticMethod()\n * MyClass.myStaticMethod[0] // First parameter of the myStaticMethod\n * MyClass.prototype.myProperty\n * MyClass.prototype.myMethod()\n * MyClass.prototype.myMethod[1] // Second parameter of myMethod\n * ```\n *\n * @param target - Class or prototype of a class\n *\n * @param member - Optional property/method name\n *\n * @param descriptorOrIndex - Optional method descriptor or parameter index\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "static getTargetName(target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string | symbol"
},
{
"kind": "Content",
"text": ", descriptorOrIndex?: "
},
{
"kind": "Reference",
"text": "TypedPropertyDescriptor",
"canonicalReference": "!TypedPropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "<any> | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": true,
"returnTypeTokenRange": {
"startIndex": 8,
"endIndex": 9
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "descriptorOrIndex",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 7
}
}
],
"name": "getTargetName"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#inherit:member(1)",
"docComment": "/**\n * Inherit metadata from base classes. By default, this method merges base metadata into the spec if `allowInheritance` is set to `true`. To customize the behavior, this method can be overridden by sub classes.\n *\n * @param inheritedMetadata - Metadata from base classes for the member\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected inherit(inheritedMetadata: "
},
{
"kind": "Content",
"text": "T | undefined | null"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "T"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "inheritedMetadata",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "inherit"
},
{
"kind": "Property",
"canonicalReference": "@loopback/metadata!DecoratorFactory#key:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "protected key: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ";"
}
],
"releaseTag": "Public",
"name": "key",
"propertyTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"isStatic": false
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#mergeWithInherited:member(1)",
"docComment": "/**\n * This method is called by the default implementation of the decorator function to merge the spec argument from the decoration with the inherited metadata for a class, all properties, all methods, or all method parameters that are decorated by this decorator.\n *\n * It MUST be overridden by subclasses to process inherited metadata.\n *\n * @param inheritedMetadata - Metadata inherited from the base classes\n *\n * @param target - Decoration target\n *\n * @param member - Optional property or method\n *\n * @param descriptorOrIndex - Optional parameter index or method descriptor\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected mergeWithInherited(inheritedMetadata: "
},
{
"kind": "Content",
"text": "M"
},
{
"kind": "Content",
"text": ", target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string | symbol"
},
{
"kind": "Content",
"text": ", descriptorOrIndex?: "
},
{
"kind": "Reference",
"text": "TypedPropertyDescriptor",
"canonicalReference": "!TypedPropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "<any> | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "M"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "inheritedMetadata",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "descriptorOrIndex",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 9
}
}
],
"name": "mergeWithInherited"
},
{
"kind": "Method",
"canonicalReference": "@loopback/metadata!DecoratorFactory#mergeWithOwn:member(1)",
"docComment": "/**\n * This method is called by the default implementation of the decorator function to merge the spec argument from the decoration with the own metadata for a class, all properties, all methods, or all method parameters that are decorated by this decorator.\n *\n * It MUST be overridden by subclasses to process own metadata.\n *\n * @param ownMetadata - Own Metadata exists locally on the target\n *\n * @param target - Decoration target\n *\n * @param member - Optional property or method\n *\n * @param descriptorOrIndex - Optional parameter index or method descriptor\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "protected mergeWithOwn(ownMetadata: "
},
{
"kind": "Content",
"text": "M"
},
{
"kind": "Content",
"text": ", target: "
},
{
"kind": "Reference",
"text": "Object",
"canonicalReference": "!Object:interface"
},
{
"kind": "Content",
"text": ", member?: "
},
{
"kind": "Content",
"text": "string | symbol"
},
{
"kind": "Content",
"text": ", descriptorOrIndex?: "
},
{
"kind": "Reference",
"text": "TypedPropertyDescriptor",
"canonicalReference": "!TypedPropertyDescriptor:interface"
},
{
"kind": "Content",
"text": "<any> | number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "M"
},
{
"kind": "Content",
"text": ";"
}
],
"isStatic": false,
"returnTypeTokenRange": {
"startIndex": 10,
"endIndex": 11
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "ownMetadata",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "target",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "member",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "descriptorOrIndex",