npm - @loopback/docs - Versions diffs - 4.0.4 → 5.0.0 - Mend

@loopback/docs 4.0.4 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (628) hide show

package/site/apidocs/express.createmiddleware.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function createMiddleware<CFG>(middlewareFactory: ExpressMiddlewa
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Express middleware factory function |
-|  middlewareConfig | CFG | Express middleware config |
+|  middlewareConfig | CFG | <i>(Optional)</i> Express middleware config |
 <b>Returns:</b>

package/site/apidocs/express.createmiddlewarebinding.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function createMiddlewareBinding(middlewareProviderClass: Constru
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareProviderClass | [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;&gt; | Middleware provider class |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Options to create middleware binding |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> Options to create middleware binding |
 <b>Returns:</b>

package/site/apidocs/express.createmiddlewareinterceptorbinding.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function createMiddlewareInterceptorBinding(middlewareProviderCla
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareProviderClass | [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;[Interceptor](./context.interceptor.md)<!-- -->&gt;&gt; | Middleware provider class |
-|  options | [MiddlewareInterceptorBindingOptions](./express.middlewareinterceptorbindingoptions.md) | Options to create middlewareFactory interceptor binding |
+|  options | [MiddlewareInterceptorBindingOptions](./express.middlewareinterceptorbindingoptions.md) | <i>(Optional)</i> Options to create middlewareFactory interceptor binding |
 <b>Returns:</b>

package/site/apidocs/express.defineinterceptorprovider.md CHANGED Viewed

@@ -26,8 +26,8 @@ export declare function defineInterceptorProvider<CFG, CTX extends Context = Inv
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Express middleware factory function |
-|  defaultMiddlewareConfig | CFG | Default middleware config |
-|  options | [MiddlewareCreationOptions](./express.middlewarecreationoptions.md) |  |
+|  defaultMiddlewareConfig | CFG | <i>(Optional)</i> Default middleware config |
+|  options | [MiddlewareCreationOptions](./express.middlewarecreationoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/express.expressapplication._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(config?: ApplicationConfig | undefined);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  config | [ApplicationConfig](./core.applicationconfig.md) \| undefined |  |
+|  config | [ApplicationConfig](./core.applicationconfig.md) \| undefined | <i>(Optional)</i> |

package/site/apidocs/express.expressmiddlewareinterceptorprovider._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(middlewareFactory: ExpressMiddlewareFactory<CFG>, middlewareConfig?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; |  |
-|  middlewareConfig | CFG \| [ContextView](./context.contextview.md)<!-- -->&lt;CFG&gt; |  |
+|  middlewareConfig | CFG \| [ContextView](./context.contextview.md)<!-- -->&lt;CFG&gt; | <i>(Optional)</i> |

package/site/apidocs/express.expressmiddlewareinterceptorprovider.md CHANGED Viewed

@@ -20,7 +20,7 @@ Base class for MiddlewareInterceptor provider classes
 ```typescript
 export declare abstract class ExpressMiddlewareInterceptorProvider<CFG, CTX extends Context = InvocationContext> implements Provider<GenericInterceptor<CTX>>
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[GenericInterceptor](./context.genericinterceptor.md)<!-- -->&lt;CTX&gt;&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[GenericInterceptor](./context.genericinterceptor.md)
 ## Example

package/site/apidocs/express.expressserver._constructor_.md CHANGED Viewed

@@ -25,7 +25,7 @@ constructor(config?: ExpressServerConfig | undefined, parent?: Context);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  config | [ExpressServerConfig](./express.expressserverconfig.md) \| undefined |  |
-|  parent | [Context](./context.context.md) |  |
+|  config | [ExpressServerConfig](./express.expressserverconfig.md) \| undefined | <i>(Optional)</i> |
+|  parent | [Context](./context.context.md) | <i>(Optional)</i> |

package/site/apidocs/express.getmiddlewarecontext.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function getMiddlewareContext<T extends MiddlewareContext = Middl
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  request | Request | Express request object |
+|  request | Request | <i>(Optional)</i> Express request object |
 <b>Returns:</b>

package/site/apidocs/express.invokemiddlewareprovider.action.md CHANGED Viewed

@@ -24,7 +24,7 @@ static action(middlewareCtx: MiddlewareContext, optionsOrHandlers?: InvokeMiddle
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareCtx | [MiddlewareContext](./express.middlewarecontext.md) |  |
-|  optionsOrHandlers | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] |  |
+|  optionsOrHandlers | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/express.invokemiddlewareprovider.value.md CHANGED Viewed

@@ -26,7 +26,7 @@ static value(
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  binding | [Binding](./context.binding.md)<!-- -->&lt;[InvokeMiddleware](./express.invokemiddleware.md)<!-- -->&gt; |  |
-|  defaultOptions | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) |  |
+|  defaultOptions | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/express.middleware.md CHANGED Viewed

@@ -20,7 +20,7 @@ Interface LoopBack 4 middleware to be executed within sequence of actions. A mid
 ```typescript
 export interface Middleware extends GenericInterceptor<MiddlewareContext>
 ```
-<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- -->&lt;[MiddlewareContext](./express.middlewarecontext.md)<!-- -->&gt;
+<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- -->&lt;[MiddlewareContext](./express.middlewarecontext.md)
 ## Remarks

package/site/apidocs/express.middlewarebindingoptions.md CHANGED Viewed

@@ -20,7 +20,7 @@ Options to bind middleware as a request context based interceptor within an `Inv
 ```typescript
 export interface MiddlewareBindingOptions extends BaseMiddlewareBindingOptions<MiddlewareContext>
 ```
-<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- -->&lt;[MiddlewareContext](./express.middlewarecontext.md)<!-- -->&gt;
+<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- -->&lt;[MiddlewareContext](./express.middlewarecontext.md)
 ## Properties

package/site/apidocs/express.middlewarechain.md CHANGED Viewed

@@ -20,6 +20,6 @@ An interceptor chain of middleware. This represents a list of cascading middlewa
 ```typescript
 export declare class MiddlewareChain extends GenericInterceptorChain<MiddlewareContext>
 ```
-<b>Extends:</b> [GenericInterceptorChain](./context.genericinterceptorchain.md)<!-- -->&lt;[MiddlewareContext](./express.middlewarecontext.md)<!-- -->&gt;
+<b>Extends:</b> [GenericInterceptorChain](./context.genericinterceptorchain.md)<!-- -->&lt;[MiddlewareContext](./express.middlewarecontext.md)

package/site/apidocs/express.middlewarecontext._constructor_.md CHANGED Viewed

@@ -27,7 +27,7 @@ constructor(request: Request, response: Response, parent?: Context, name?: strin
 |  --- | --- | --- |
 |  request | Request | Express request object |
 |  response | Response | Express response object |
-|  parent | [Context](./context.context.md) | Parent context |
-|  name | string | Name of the middleware context |
+|  parent | [Context](./context.context.md) | <i>(Optional)</i> Parent context |
+|  name | string | <i>(Optional)</i> Name of the middleware context |

package/site/apidocs/express.middlewareinterceptorbindingoptions.md CHANGED Viewed

@@ -20,7 +20,7 @@ Options to bind a middleware as an interceptor to the context
 ```typescript
 export interface MiddlewareInterceptorBindingOptions extends BaseMiddlewareBindingOptions<InvocationContext>
 ```
-<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- -->&lt;[InvocationContext](./context.invocationcontext.md)<!-- -->&gt;
+<b>Extends:</b> [BaseMiddlewareBindingOptions](./express.basemiddlewarebindingoptions.md)<!-- -->&lt;[InvocationContext](./context.invocationcontext.md)
 ## Properties

package/site/apidocs/express.middlewareregistry.expressmiddleware.md CHANGED Viewed

@@ -27,7 +27,7 @@ expressMiddleware(key: BindingAddress, middleware: ExpressRequestHandler | Expre
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md) | Middleware binding key |
 |  middleware | [ExpressRequestHandler](./express.expressrequesthandler.md) \| [ExpressRequestHandler](./express.expressrequesthandler.md)<!-- -->\[\] | Express middleware handler function(s) |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) |  |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/express.middlewareregistry.expressmiddleware_1.md CHANGED Viewed

@@ -26,8 +26,8 @@ expressMiddleware<CFG>(middlewareFactory: ExpressMiddlewareFactory<CFG>, middlew
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Middleware module name or factory function |
-|  middlewareConfig | CFG | Middleware config |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Options for registration |
+|  middlewareConfig | CFG | <i>(Optional)</i> Middleware config |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> Options for registration |
 <b>Returns:</b>

package/site/apidocs/express.middlewareregistry.middleware.md CHANGED Viewed

@@ -26,7 +26,7 @@ middleware(middleware: Middleware | Constructor<Provider<Middleware>>, options?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middleware | [Middleware](./express.middleware.md) \| [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;&gt; | Middleware function or provider class |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Middleware binding options |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> Middleware binding options |
 <b>Returns:</b>

package/site/apidocs/express.middlewareview._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(ctx: Context, options?: InvokeMiddlewareOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) |  |
-|  options | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) |  |
+|  options | [InvokeMiddlewareOptions](./express.invokemiddlewareoptions.md) | <i>(Optional)</i> |

package/site/apidocs/express.registerexpressmiddleware.md CHANGED Viewed

@@ -27,8 +27,8 @@ export declare function registerExpressMiddleware<CFG>(ctx: Context, middlewareF
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context object |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Middleware module name or factory function |
-|  middlewareConfig | CFG | Middleware config |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Options for registration |
+|  middlewareConfig | CFG | <i>(Optional)</i> Middleware config |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> Options for registration |
 <b>Returns:</b>

package/site/apidocs/express.registerexpressmiddlewareinterceptor.md CHANGED Viewed

@@ -27,8 +27,8 @@ export declare function registerExpressMiddlewareInterceptor<CFG>(ctx: Context,
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context object |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Express middleware factory function |
-|  middlewareConfig | CFG | Express middleware config |
-|  options | [MiddlewareInterceptorBindingOptions](./express.middlewareinterceptorbindingoptions.md) | Options for registration |
+|  middlewareConfig | CFG | <i>(Optional)</i> Express middleware config |
+|  options | [MiddlewareInterceptorBindingOptions](./express.middlewareinterceptorbindingoptions.md) | <i>(Optional)</i> Options for registration |
 <b>Returns:</b>

package/site/apidocs/filter.filterbuilder._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(f?: Filter<MT>);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  f | [Filter](./filter.filter.md)<!-- -->&lt;MT&gt; |  |
+|  f | [Filter](./filter.filter.md)<!-- -->&lt;MT&gt; | <i>(Optional)</i> |

package/site/apidocs/filter.inclusion.md CHANGED Viewed

@@ -31,5 +31,6 @@ export interface Inclusion
 |  --- | --- | --- |
 |  [relation](./filter.inclusion.relation.md) | string |  |
 |  [scope?](./filter.inclusion.scope.md) | [Filter](./filter.filter.md)<!-- -->&lt;AnyObject&gt; &amp; { totalLimit?: number; } | <i>(Optional)</i> |
+|  [targetType?](./filter.inclusion.targettype.md) | string | <i>(Optional)</i> |

package/site/apidocs/filter.inclusion.targettype.md ADDED Viewed

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: filter.inclusion.targettype'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/filter
+permalink: /doc/en/lb4/apidocs.filter.inclusion.targettype.html
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+[Home](./index.md) &gt; [@loopback/filter](./filter.md) &gt; [Inclusion](./filter.inclusion.md) &gt; [targetType](./filter.inclusion.targettype.md)
+## Inclusion.targetType property
+<b>Signature:</b>
+```typescript
+targetType?: string;
+```

package/site/apidocs/filter.wherebuilder._constructor_.md CHANGED Viewed

@@ -25,6 +25,6 @@ constructor(w?: Where<MT>);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  w | [Where](./filter.where.md)<!-- -->&lt;MT&gt; |  |
+|  w | [Where](./filter.where.md)<!-- -->&lt;MT&gt; | <i>(Optional)</i> |

package/site/apidocs/filter.wherebuilder.exists.md CHANGED Viewed

@@ -26,7 +26,7 @@ exists<K extends KeyOf<MT>>(key: K, val?: boolean): this;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | K | Property name |
-|  val | boolean | Exists or not |
+|  val | boolean | <i>(Optional)</i> Exists or not |
 <b>Returns:</b>

package/site/apidocs/graphql.graphqlserver._constructor_.md CHANGED Viewed

@@ -25,7 +25,7 @@ constructor(options?: GraphQLServerOptions, parent?: Context);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [GraphQLServerOptions](./graphql.graphqlserveroptions.md) |  |
-|  parent | [Context](./context.context.md) |  |
+|  options | [GraphQLServerOptions](./graphql.graphqlserveroptions.md) | <i>(Optional)</i> |
+|  parent | [Context](./context.context.md) | <i>(Optional)</i> |

package/site/apidocs/graphql.graphqlserver.exportgraphqlschema.md CHANGED Viewed

@@ -23,8 +23,8 @@ exportGraphQLSchema(outFile?: string, log?: (message?: any, ...optionalParams: a
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  outFile | string |  |
-|  log | (message?: any, ...optionalParams: any\[\]) =&gt; void |  |
+|  outFile | string | <i>(Optional)</i> |
+|  log | (message?: any, ...optionalParams: any\[\]) =&gt; void | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/graphql.graphqlserver.resolver.md CHANGED Viewed

@@ -26,7 +26,7 @@ resolver(resolverClass: Constructor<ResolverInterface<object>>, nameOrOptions?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  resolverClass | [Constructor](./context.constructor.md)<!-- -->&lt;ResolverInterface&lt;object&gt;&gt; | GraphQL resolver class |
-|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | Resolver name or binding options |
+|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> Resolver name or binding options |
 <b>Returns:</b>

package/site/apidocs/graphql.registerresolver.md CHANGED Viewed

@@ -27,7 +27,7 @@ export declare function registerResolver(ctx: Context, resolverClass: Constructo
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context object |
 |  resolverClass | [Constructor](./context.constructor.md)<!-- -->&lt;object&gt; | Resolver class |
-|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | Resolver name or binding options |
+|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> Resolver name or binding options |
 <b>Returns:</b>

package/site/apidocs/health.healthcomponent._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(application: Application, healthConfig?: HealthConfig);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  application | [Application](./core.application.md) |  |
-|  healthConfig | [HealthConfig](./health.healthconfig.md) |  |
+|  healthConfig | [HealthConfig](./health.healthconfig.md) | <i>(Optional)</i> |

package/site/apidocs/http-server.basehttpoptions.md CHANGED Viewed

@@ -20,7 +20,7 @@ Base options that are common to http and https servers
 ```typescript
 export interface BaseHttpOptions extends ListenOptions, Partial<HttpServerProperties>
 ```
-<b>Extends:</b> ListenOptions, Partial&lt;[HttpServerProperties](./http-server.httpserverproperties.md)<!-- -->&gt;
+<b>Extends:</b> ListenOptions, Partial&lt;[HttpServerProperties](./http-server.httpserverproperties.md)
 ## Properties

package/site/apidocs/http-server.httpserver._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(requestListener: RequestListener, serverOptions?: HttpServerOptions)
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  requestListener | [RequestListener](./http-server.requestlistener.md) |  |
-|  serverOptions | [HttpServerOptions](./http-server.httpserveroptions.md) |  |
+|  serverOptions | [HttpServerOptions](./http-server.httpserveroptions.md) | <i>(Optional)</i> |

package/site/apidocs/logging.winstonloggerprovider._constructor_.md CHANGED Viewed

@@ -30,6 +30,6 @@ constructor(
 |  --- | --- | --- |
 |  transports | [Getter](./context.getter.md)<!-- -->&lt;Transport\[\]&gt; |  |
 |  formats | [Getter](./context.getter.md)<!-- -->&lt;Format\[\]&gt; |  |
-|  options | LoggerOptions |  |
+|  options | LoggerOptions | <i>(Optional)</i> |

package/site/apidocs/logging.winstonloggerprovider.md CHANGED Viewed

@@ -20,7 +20,7 @@ A provider class that creates WinstonLogger instances
 ```typescript
 export declare class WinstonLoggerProvider implements Provider<Logger>
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;Logger&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;Logger
 ## Constructors

package/site/apidocs/metadata.classdecoratorfactory.createdecorator.md CHANGED Viewed

@@ -27,7 +27,7 @@ static createDecorator<S>(key: MetadataKey<S, ClassDecorator>, spec: S, options?
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;S, ClassDecorator&gt; | Metadata key |
 |  spec | S | Metadata object from the decorator function |
-|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | Options for the decorator |
+|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | <i>(Optional)</i> Options for the decorator |
 <b>Returns:</b>

package/site/apidocs/metadata.classdecoratorfactory.md CHANGED Viewed

@@ -20,7 +20,7 @@ Factory for class decorators
 ```typescript
 export declare class ClassDecoratorFactory<T> extends DecoratorFactory<T, T, ClassDecorator>
 ```
-<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, T, ClassDecorator&gt;
+<b>Extends:</b> [DecoratorFactory](./metadata.decoratorfactory.md)<!-- -->&lt;T, T, ClassDecorator
 ## Methods

package/site/apidocs/metadata.classdecoratorfactory.mergewithinherited.md CHANGED Viewed

@@ -25,8 +25,8 @@ protected mergeWithInherited(inheritedMetadata: T, target: Object, member?: stri
 |  --- | --- | --- |
 |  inheritedMetadata | T |  |
 |  target | Object |  |
-|  member | string |  |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number |  |
+|  member | string | <i>(Optional)</i> |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/metadata.classdecoratorfactory.mergewithown.md CHANGED Viewed

@@ -25,8 +25,8 @@ protected mergeWithOwn(ownMetadata: T, target: Object, member?: string, descript
 |  --- | --- | --- |
 |  ownMetadata | T |  |
 |  target | Object |  |
-|  member | string |  |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number |  |
+|  member | string | <i>(Optional)</i> |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/metadata.decoratorfactory._constructor_.md CHANGED Viewed

@@ -27,6 +27,6 @@ constructor(key: string, spec: T, options?: DecoratorOptions);
 |  --- | --- | --- |
 |  key | string | Metadata key |
 |  spec | T | Metadata object from the decorator function |
-|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | Options for the decorator. Default to <code>{allowInheritance: true}</code> if not provided |
+|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | <i>(Optional)</i> Options for the decorator. Default to <code>{allowInheritance: true}</code> if not provided |

package/site/apidocs/metadata.decoratorfactory._createdecorator.md CHANGED Viewed

@@ -27,7 +27,7 @@ protected static _createDecorator<S, MT extends S | MetadataMap<S> | MetadataMap
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;S, DT&gt; | Metadata key |
 |  spec | S | Metadata object from the decorator function |
-|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | Options for the decorator |
+|  options | [DecoratorOptions](./metadata.decoratoroptions.md) | <i>(Optional)</i> Options for the decorator |
 <b>Returns:</b>

package/site/apidocs/metadata.decoratorfactory.decorate.md CHANGED Viewed

@@ -26,8 +26,8 @@ protected decorate(target: Object, member?: string | symbol, descriptorOrIndex?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | Object | Decorator target |
-|  member | string \| symbol | Optional property or method |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | Optional method descriptor or parameter index |
+|  member | string \| symbol | <i>(Optional)</i> Optional property or method |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> Optional method descriptor or parameter index |
 <b>Returns:</b>

package/site/apidocs/metadata.decoratorfactory.duplicatedecorationerror.md CHANGED Viewed

@@ -26,8 +26,8 @@ protected duplicateDecorationError(target: Object, member?: string | symbol, des
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | Object | Decoration target |
-|  member | string \| symbol | Optional property or method |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | Optional parameter index or method descriptor |
+|  member | string \| symbol | <i>(Optional)</i> Optional property or method |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> Optional parameter index or method descriptor |
 <b>Returns:</b>

package/site/apidocs/metadata.decoratorfactory.getnumberofparameters.md CHANGED Viewed

@@ -26,7 +26,7 @@ static getNumberOfParameters(target: Object, member?: string): number;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | Object | Class or the prototype |
-|  member | string | Method name |
+|  member | string | <i>(Optional)</i> Method name |
 <b>Returns:</b>

package/site/apidocs/metadata.decoratorfactory.gettargetname.md CHANGED Viewed

@@ -26,8 +26,8 @@ static getTargetName(target: Object, member?: string | symbol, descriptorOrIndex
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | Object | Class or prototype of a class |
-|  member | string \| symbol | Optional property/method name |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | Optional method descriptor or parameter index |
+|  member | string \| symbol | <i>(Optional)</i> Optional property/method name |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> Optional method descriptor or parameter index |
 <b>Returns:</b>

package/site/apidocs/metadata.decoratorfactory.mergewithinherited.md CHANGED Viewed

@@ -29,8 +29,8 @@ protected mergeWithInherited(inheritedMetadata: M, target: Object, member?: stri
 |  --- | --- | --- |
 |  inheritedMetadata | M | Metadata inherited from the base classes |
 |  target | Object | Decoration target |
-|  member | string \| symbol | Optional property or method |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | Optional parameter index or method descriptor |
+|  member | string \| symbol | <i>(Optional)</i> Optional property or method |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> Optional parameter index or method descriptor |
 <b>Returns:</b>

package/site/apidocs/metadata.decoratorfactory.mergewithown.md CHANGED Viewed

@@ -29,8 +29,8 @@ protected mergeWithOwn(ownMetadata: M, target: Object, member?: string | symbol,
 |  --- | --- | --- |
 |  ownMetadata | M | Own Metadata exists locally on the target |
 |  target | Object | Decoration target |
-|  member | string \| symbol | Optional property or method |
-|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | Optional parameter index or method descriptor |
+|  member | string \| symbol | <i>(Optional)</i> Optional property or method |
+|  descriptorOrIndex | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> Optional parameter index or method descriptor |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.definemetadata.md CHANGED Viewed

@@ -28,7 +28,7 @@ static defineMetadata<T>(key: MetadataKey<T, DecoratorType>, value: T, target: O
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;T, [DecoratorType](./metadata.decoratortype.md)<!-- -->&gt; | Metadata key |
 |  value | T | Metadata value |
 |  target | Object | Target for the metadata |
-|  member | string | Optional property or method name |
+|  member | string | <i>(Optional)</i> Optional property or method name |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.getallmethodmetadata.md CHANGED Viewed

@@ -27,7 +27,7 @@ static getAllMethodMetadata<T>(key: MetadataKey<T, MethodDecorator>, target: Obj
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;T, MethodDecorator&gt; | Metadata key |
 |  target | Object | Class for static methods or prototype for instance methods |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | Options for inspection |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> Options for inspection |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.getallparametermetadata.md CHANGED Viewed

@@ -27,8 +27,8 @@ static getAllParameterMetadata<T>(key: MetadataKey<T, ParameterDecorator>, targe
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;T, ParameterDecorator&gt; | Metadata key |
 |  target | Object | Class for static methods or prototype for instance methods |
-|  methodName | string | Method name. If not present, default to '' to use the constructor |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | Options for inspection |
+|  methodName | string | <i>(Optional)</i> Method name. If not present, default to '' to use the constructor |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> Options for inspection |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.getallpropertymetadata.md CHANGED Viewed

@@ -27,7 +27,7 @@ static getAllPropertyMetadata<T>(key: MetadataKey<T, PropertyDecorator>, target:
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;T, PropertyDecorator&gt; | Metadata key |
 |  target | Object | Class for static methods or prototype for instance methods |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | Options for inspection |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> Options for inspection |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.getclassmetadata.md CHANGED Viewed

@@ -27,7 +27,7 @@ static getClassMetadata<T>(key: MetadataKey<T, ClassDecorator>, target: Function
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;T, ClassDecorator&gt; | Metadata key |
 |  target | Function | Class that contains the metadata |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | Options for inspection |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> Options for inspection |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.getmethodmetadata.md CHANGED Viewed

@@ -27,8 +27,8 @@ static getMethodMetadata<T>(key: MetadataKey<T, MethodDecorator>, target: Object
 |  --- | --- | --- |
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;T, MethodDecorator&gt; | Metadata key |
 |  target | Object | Class for static methods or prototype for instance methods |
-|  methodName | string | Method name. If not present, default to '' to use the constructor |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | Options for inspection |
+|  methodName | string | <i>(Optional)</i> Method name. If not present, default to '' to use the constructor |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> Options for inspection |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.getparametermetadata.md CHANGED Viewed

@@ -29,7 +29,7 @@ static getParameterMetadata<T>(key: MetadataKey<T, ParameterDecorator>, target:
 |  target | Object | Class for static methods or prototype for instance methods |
 |  methodName | string | Method name. If not present, default to '' to use the constructor |
 |  index | number | Index of the parameter, starting with 0 |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | Options for inspection |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> Options for inspection |
 <b>Returns:</b>

package/site/apidocs/metadata.metadatainspector.getpropertymetadata.md CHANGED Viewed

@@ -28,7 +28,7 @@ static getPropertyMetadata<T>(key: MetadataKey<T, PropertyDecorator>, target: Ob
 |  key | [MetadataKey](./metadata.metadatakey.md)<!-- -->&lt;T, PropertyDecorator&gt; | Metadata key |
 |  target | Object | Class for static properties or prototype for instance properties |
 |  propertyName | string | Property name |
-|  options | [InspectionOptions](./metadata.inspectionoptions.md) | Options for inspection |
+|  options | [InspectionOptions](./metadata.inspectionoptions.md) | <i>(Optional)</i> Options for inspection |
 <b>Returns:</b>