@loopback/docs
Version:
Documentation for LoopBack 4
2,217 lines (1,531 loc) • 125 kB
HTML
<!DOCTYPE html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title></title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="css/bootstrap.min.css">
<link rel="stylesheet" href="css/code-themes/sl-theme.css">
<link rel="stylesheet" href="css/main.css">
</head>
<body>
<div class="navbar navbar-inverse navbar-static-top" role="navigation">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">docs.strongloop.com</a>
</div>
<div id="modules"></div>
</div>
<div class="row">
<div class="col-lg-3 column scroll-spy-target">
<ul class="nav nav-pills nav-stacked">
<div id="versions"></div>
<li class="depth-3">
<a href="#ClassDecoratorFactory">Class: ClassDecoratorFactory</a>
</li>
<li class="depth-4">
<a href="#ClassDecoratorFactory.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#ClassDecoratorFactory.createDecorator">static createDecorator()</a>
</li>
<li class="depth-3">
<a href="#DecoratorFactory">Class: DecoratorFactory</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.TARGET">static TARGET</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.prototype.getTarget">getTarget()</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.prototype.withTarget">withTarget()</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.cloneDeep">static cloneDeep()</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.getNumberOfParameters">static getNumberOfParameters()</a>
</li>
<li class="depth-4">
<a href="#DecoratorFactory.getTargetName">static getTargetName()</a>
</li>
<li class="depth-3">
<a href="#MethodDecoratorFactory">Class: MethodDecoratorFactory</a>
</li>
<li class="depth-4">
<a href="#MethodDecoratorFactory.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#MethodDecoratorFactory.createDecorator">static createDecorator()</a>
</li>
<li class="depth-3">
<a href="#MethodParameterDecoratorFactory">Class: MethodParameterDecoratorFactory</a>
</li>
<li class="depth-4">
<a href="#MethodParameterDecoratorFactory.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#MethodParameterDecoratorFactory.createDecorator">static createDecorator()</a>
</li>
<li class="depth-3">
<a href="#ParameterDecoratorFactory">Class: ParameterDecoratorFactory</a>
</li>
<li class="depth-4">
<a href="#ParameterDecoratorFactory.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#ParameterDecoratorFactory.createDecorator">static createDecorator()</a>
</li>
<li class="depth-3">
<a href="#PropertyDecoratorFactory">Class: PropertyDecoratorFactory</a>
</li>
<li class="depth-4">
<a href="#PropertyDecoratorFactory.prototype.create">create()</a>
</li>
<li class="depth-4">
<a href="#PropertyDecoratorFactory.createDecorator">static createDecorator()</a>
</li>
<li class="depth-3">
<a href="#DecoratorOptions">Interface: DecoratorOptions</a>
</li>
<li class="depth-4">
<a href="#DecoratorOptions.prototype.allowInheritance">allowInheritance</a>
</li>
<li class="depth-4">
<a href="#DecoratorOptions.prototype.cloneInputSpec">cloneInputSpec</a>
</li>
<li class="depth-3">
<a href="#MetadataInspector">Class: MetadataInspector</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.DesignTimeReflector">static DesignTimeReflector</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.Reflector">static Reflector</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.defineMetadata">static defineMetadata()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getAllMethodMetadata">static getAllMethodMetadata()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getAllParameterMetadata">static getAllParameterMetadata()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getAllPropertyMetadata">static getAllPropertyMetadata()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getClassMetadata">static getClassMetadata()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getDesignTypeForMethod">static getDesignTypeForMethod()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getDesignTypeForProperty">static getDesignTypeForProperty()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getMethodMetadata">static getMethodMetadata()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getParameterMetadata">static getParameterMetadata()</a>
</li>
<li class="depth-4">
<a href="#MetadataInspector.getPropertyMetadata">static getPropertyMetadata()</a>
</li>
<li class="depth-3">
<a href="#InspectionOptions">Interface: InspectionOptions</a>
</li>
<li class="depth-4">
<a href="#InspectionOptions.prototype.ownMetadataOnly">ownMetadataOnly</a>
</li>
<li class="depth-3">
<a href="#NamespacedReflect">Class: NamespacedReflect</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.constructor">constructor()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.decorate">decorate()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.defineMetadata">defineMetadata()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.deleteMetadata">deleteMetadata()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.getMetadata">getMetadata()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.getMetadataKeys">getMetadataKeys()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.getOwnMetadata">getOwnMetadata()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.getOwnMetadataKeys">getOwnMetadataKeys()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.hasMetadata">hasMetadata()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.hasOwnMetadata">hasOwnMetadata()</a>
</li>
<li class="depth-4">
<a href="#NamespacedReflect.prototype.metadata">metadata()</a>
</li>
<li class="depth-3">
<a href="#Reflector">Reflector</a>
</li>
<li class="depth-3">
<a href="#MetadataAccessor">Class: MetadataAccessor</a>
</li>
<li class="depth-4">
<a href="#MetadataAccessor.prototype.toString">toString()</a>
</li>
<li class="depth-4">
<a href="#MetadataAccessor.create">static create()</a>
</li>
<li class="depth-3">
<a href="#DesignTimeMethodMetadata">Interface: DesignTimeMethodMetadata</a>
</li>
<li class="depth-4">
<a href="#DesignTimeMethodMetadata.prototype.parameterTypes">parameterTypes</a>
</li>
<li class="depth-4">
<a href="#DesignTimeMethodMetadata.prototype.returnType">returnType</a>
</li>
<li class="depth-4">
<a href="#DesignTimeMethodMetadata.prototype.type">type</a>
</li>
<li class="depth-3">
<a href="#MetadataMap">Interface: MetadataMap</a>
</li>
<li class="depth-3">
<a href="#DecoratorType">Type: DecoratorType</a>
</li>
<li class="depth-3">
<a href="#MetadataKey">Type: MetadataKey</a>
</li>
</ul>
</div>
<div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0">
<div class="readability">
<section class="code-doc ">
<a name="ClassDecoratorFactory"></a>
<h3 class="code-ref">Class: classdecoratorfactory = new ClassDecoratorFactory()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Factory for class decorators</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="ClassDecoratorFactory.prototype.create"></a>
<h4 class="code-ref">create() : <a href="#ClassDecorator">ClassDecorator</a></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="ClassDecoratorFactory.createDecorator"></a>
<h4 class="code-ref">createDecorator(key: <a href="#MetadataKey">MetadataKey</a><T, <a href="#ClassDecorator">ClassDecorator</a>>, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : anonymous</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Create a class decorator function</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
key
</strong>
</td>
<td class="code-arg-types">
<code><a href="#MetadataKey">MetadataKey</a><T, <a href="#ClassDecorator">ClassDecorator</a>></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata key</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata object from the decorator function</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#DecoratorOptions">DecoratorOptions</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Options for the decorator</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorFactory"></a>
<h3 class="code-ref">Class: decoratorfactory = new DecoratorFactory()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Base factory class for decorator functions</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name="DecoratorFactory.TARGET"></a>
<strong class="code-arg-name">
TARGET
</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-default-value">
"__decoratorTarget"
</td>
<td class="code-arg-flags">
static exported
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>A constant to reference the target of a decoration</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorFactory.constructor"></a>
<h4 class="code-ref">constructor(key: string, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : <a href="#DecoratorFactory">DecoratorFactory</a></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Construct a new class decorator factory</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
key
</strong>
</td>
<td class="code-arg-types">
<code>string</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Metadata key</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Metadata object from the decorator function</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#DecoratorOptions">DecoratorOptions</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Options for the decorator. Default to
<code>{allowInheritance: true}</code> if not provided</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorFactory.prototype.create"></a>
<h4 class="code-ref">create() : D</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Create a decorator function of the given type. Each sub class MUST
implement this method.</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="DecoratorFactory.prototype.getTarget"></a>
<h4 class="code-ref">getTarget(spec: T) : any</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Get the optional decoration target of a given spec</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata spec</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorFactory.prototype.withTarget"></a>
<h4 class="code-ref">withTarget(spec: T, target: <a href="#Object">Object</a>) : T</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Set a reference to the target class or prototype for a given spec if
it's an object</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata spec</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
target
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Object">Object</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Target of the decoration. It is a class or the prototype of
a class.</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorFactory.cloneDeep"></a>
<h4 class="code-ref">cloneDeep(val: <a href="#Readonly">Readonly</a><V>) : V</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
val
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Readonly">Readonly</a><V></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Base factory class for decorator functions</p>
</p>
<p></p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorFactory.getNumberOfParameters"></a>
<h4 class="code-ref">getNumberOfParameters(target: <a href="#Object">Object</a>, member: undefined | string) : number</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Get the number of parameters for a given constructor or method</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
target
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Object">Object</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Class or the prototype</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
member
</strong>
</td>
<td class="code-arg-types">
<code>undefined | string</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Method name</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorFactory.getTargetName"></a>
<h4 class="code-ref">getTargetName(target: <a href="#Object">Object</a>, member: undefined | string, descriptorOrIndex: <a href="#TypedPropertyDescriptor">TypedPropertyDescriptor</a><any> | number) : string</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Get the qualified name of a decoration target. For example:</p>
<pre><code>class MyClass
MyClass<span class="hljs-selector-class">.constructor</span>[<span class="hljs-number">0</span>] <span class="hljs-comment">// First parameter of the constructor</span>
MyClass<span class="hljs-selector-class">.myStaticProperty</span>
MyClass.myStaticMethod()
MyClass<span class="hljs-selector-class">.myStaticMethod</span>[<span class="hljs-number">0</span>] <span class="hljs-comment">// First parameter of the myStaticMethod</span>
MyClass<span class="hljs-selector-class">.prototype</span><span class="hljs-selector-class">.myProperty</span>
MyClass<span class="hljs-selector-class">.prototype</span><span class="hljs-selector-class">.myMethod</span>()
MyClass<span class="hljs-selector-class">.prototype</span><span class="hljs-selector-class">.myMethod</span>[<span class="hljs-number">1</span>] <span class="hljs-comment">// Second parameter of myMethod</span></code></pre></p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
target
</strong>
</td>
<td class="code-arg-types">
<code><a href="#Object">Object</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Class or prototype of a class</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
member
</strong>
</td>
<td class="code-arg-types">
<code>undefined | string</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Optional property/method name</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
descriptorOrIndex
</strong>
</td>
<td class="code-arg-types">
<code><a href="#TypedPropertyDescriptor">TypedPropertyDescriptor</a><any> | number</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Optional method descriptor or parameter index</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="MethodDecoratorFactory"></a>
<h3 class="code-ref">Class: methoddecoratorfactory = new MethodDecoratorFactory()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Factory for method decorators</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="MethodDecoratorFactory.prototype.create"></a>
<h4 class="code-ref">create() : <a href="#MethodDecorator">MethodDecorator</a></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="MethodDecoratorFactory.createDecorator"></a>
<h4 class="code-ref">createDecorator(key: <a href="#MetadataKey">MetadataKey</a><T, <a href="#MethodDecorator">MethodDecorator</a>>, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : anonymous</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Create a method decorator function</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
key
</strong>
</td>
<td class="code-arg-types">
<code><a href="#MetadataKey">MetadataKey</a><T, <a href="#MethodDecorator">MethodDecorator</a>></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata key</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata object from the decorator function</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#DecoratorOptions">DecoratorOptions</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Options for the decorator</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="MethodParameterDecoratorFactory"></a>
<h3 class="code-ref">Class: methodparameterdecoratorfactory = new MethodParameterDecoratorFactory()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Factory for method level parameter decorator. For example, the following
code uses <code>@param</code> to declare two parameters for <code>greet()</code>.</p>
<pre><code class="language-ts"><span class="hljs-selector-tag">class</span> <span class="hljs-selector-tag">MyController</span> {
<span class="hljs-variable">@param</span>(<span class="hljs-string">'name'</span>) <span class="hljs-comment">// Parameter 0</span>
<span class="hljs-variable">@param</span>(<span class="hljs-string">'msg'</span>) <span class="hljs-comment">// Parameter 1</span>
greet() {}
}</code></pre>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="MethodParameterDecoratorFactory.prototype.create"></a>
<h4 class="code-ref">create() : <a href="#MethodDecorator">MethodDecorator</a></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="MethodParameterDecoratorFactory.createDecorator"></a>
<h4 class="code-ref">createDecorator(key: <a href="#MetadataKey">MetadataKey</a><T, <a href="#MethodDecorator">MethodDecorator</a>>, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : anonymous</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Create a method decorator function</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
key
</strong>
</td>
<td class="code-arg-types">
<code><a href="#MetadataKey">MetadataKey</a><T, <a href="#MethodDecorator">MethodDecorator</a>></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata key</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata object from the decorator function</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#DecoratorOptions">DecoratorOptions</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Options for the decorator</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="ParameterDecoratorFactory"></a>
<h3 class="code-ref">Class: parameterdecoratorfactory = new ParameterDecoratorFactory()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Factory for parameter decorators</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="ParameterDecoratorFactory.prototype.create"></a>
<h4 class="code-ref">create() : <a href="#ParameterDecorator">ParameterDecorator</a></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="ParameterDecoratorFactory.createDecorator"></a>
<h4 class="code-ref">createDecorator(key: <a href="#MetadataKey">MetadataKey</a><T, <a href="#ParameterDecorator">ParameterDecorator</a>>, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : anonymous</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Create a parameter decorator function</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
key
</strong>
</td>
<td class="code-arg-types">
<code><a href="#MetadataKey">MetadataKey</a><T, <a href="#ParameterDecorator">ParameterDecorator</a>></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata key</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata object from the decorator function</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#DecoratorOptions">DecoratorOptions</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Options for the decorator</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="PropertyDecoratorFactory"></a>
<h3 class="code-ref">Class: propertydecoratorfactory = new PropertyDecoratorFactory()</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Factory for property decorators</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc ">
<a name="PropertyDecoratorFactory.prototype.create"></a>
<h4 class="code-ref">create() : <a href="#PropertyDecorator">PropertyDecorator</a></h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
</section>
<section class="code-doc ">
<a name="PropertyDecoratorFactory.createDecorator"></a>
<h4 class="code-ref">createDecorator(key: <a href="#MetadataKey">MetadataKey</a><T, <a href="#PropertyDecorator">PropertyDecorator</a>>, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : anonymous</h4>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Create a property decorator function</p>
</p>
<p></p>
</div>
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Parameters</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
key
</strong>
</td>
<td class="code-arg-types">
<code><a href="#MetadataKey">MetadataKey</a><T, <a href="#PropertyDecorator">PropertyDecorator</a>></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata key</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
spec
</strong>
</td>
<td class="code-arg-types">
<code>T</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Metadata object from the decorator function</p>
</p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name=""></a>
<strong class="code-arg-name">
options
</strong>
</td>
<td class="code-arg-types">
<code><a href="#DecoratorOptions">DecoratorOptions</a></code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p></p>
<p><p>Options for the decorator</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="DecoratorOptions"></a>
<h3 class="code-ref">Interface: DecoratorOptions</h3>
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Options for a decorator</p>
</p>
<p></p>
</div>
</section>
<section class="code-doc">
<!-- A table of members such as parameters/properties/variables -->
<div class="code-arguments-hdr">Properties</div>
<table class="params code-arguments">
<tr>
<th class="hdr-name">Name</th>
<th class="hdr-type">Type</th>
<th class="hdr-default-value">Default Value</th>
<th class="hdr-flags">Flags</th>
<th class="hdr-desc">Description</th>
</tr>
<tr class="code-arg">
<td>
<a name="DecoratorOptions.prototype.allowInheritance"></a>
<strong class="code-arg-name">
allowInheritance
</strong>
</td>
<td class="code-arg-types">
<code>undefined | false | true</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
exported optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Controls if inherited metadata will be honored. Default to <code>true</code>.</p>
</p>
<p></p>
</div>
</td>
</tr>
<tr class="code-arg">
<td>
<a name="DecoratorOptions.prototype.cloneInputSpec"></a>
<strong class="code-arg-name">
cloneInputSpec
</strong>
</td>
<td class="code-arg-types">
<code>undefined | false | true</code>
</td>
<td class="code-arg-default-value">
</td>
<td class="code-arg-flags">
exported optional
</td>
<td class="code-arg-desc">
<!--
Used for displaying comments in Class, Interface, Properties Constructor,
Function and Parameters of constructor or function.
(Excludes Type alias).
-->
<div class="code-desc">
<p><p>Controls if the value of <code>spec</code> argument will be cloned. Sometimes we
use shared spec for the decoration, but the decorator function might need
to mutate the object. Cloning the input spec makes it safe to use the same
spec (<code>template</code>) to decorate different members.</p>
</p>
<p><p>Default to <code>true</code>.</p>
</p>
</div>
</td>
</tr>
</table>
</section>
<section class="code-doc ">
<a name="MetadataInspector"></a>
<h3 class="code-ref">Class: metadatainspector = new MetadataInspector()</h3>
<!-