@loopback/docs 4.0.2 → 5.0.0

package/site/Setting-debug-strings.md

@@ -84,7 +84,7 @@ For example:
 
 `loopback:cli:model-generator`
 
-The debug string `model-generator` is specified in the source file
+The debug string `model-generator` is specified in the source file 
 [`generators/model/index.js`](https://github.com/loopbackio/loopback-next/blob/master/packages/cli/generators/model/index.js)
 of the `@loopback/cli` module.
 
@@ -363,3 +363,34 @@ of the `@loopback/cli` module.
     </tr>
   </tbody>
 </table>
+
+## Adding debugs
+
+As seen before, LoopBack has built-in debug strings to help with debugging.
+
+LoopBack uses the `debug` package internally. Even if there's no mandate for
+LoopBack users to use the same library, you can use this package in your
+application to help with debugging.
+
+To do so, you can define your own debug strings like demonstrated in this
+example:
+
+```ts
+// Import from debug
+import debugFactory from 'debug';
+
+// Define your custom debug string
+const debug = debugFactory('example:debug:factory');
+
+// Use it in your code
+debug('Oops there was an error!');
+```
+
+To debug parts of your app with this custom debug string, you can run:
+
+```sh
+DEBUG=example:debug:factory npm start
+```
+
+> Refer to the [debug](https://www.npmjs.com/package/debug) documentation for
+> more information.

package/site/apidocs/apiconnect.apiconnectspecenhancer._constructor_.md

@@ -26,6 +26,6 @@ constructor(options: ApiConnectSpecOptions, appMetadata?: ApplicationMetadata);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  options | [ApiConnectSpecOptions](./apiconnect.apiconnectspecoptions.md) |  |
-|  appMetadata | [ApplicationMetadata](./core.applicationmetadata.md) |  |
+|  appMetadata | [ApplicationMetadata](./core.applicationmetadata.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication-jwt.myuserservice.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.myuserservice.html
 ```typescript
 export declare class MyUserService implements UserService<User, Credentials> 
 ```
-<b>Implements:</b> [UserService](./authentication.userservice.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, [Credentials](./authentication-jwt.credentials.md)<!-- -->&gt;
+<b>Implements:</b> [UserService](./authentication.userservice.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, [Credentials](./authentication-jwt.credentials.md)
 
 ## Constructors
 

package/site/apidocs/authentication-jwt.refreshtoken._constructor_.md

@@ -25,6 +25,6 @@ constructor(data?: Partial<RefreshToken>);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | Partial&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->&gt; |  |
+|  data | Partial&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication-jwt.refreshtokenrepository.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.refreshtokenrepository.html
 ```typescript
 export declare class RefreshTokenRepository extends DefaultCrudRepository<RefreshToken, typeof RefreshToken.prototype.id, RefreshTokenRelations> 
 ```
-<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->, typeof [RefreshToken.prototype.id](./authentication-jwt.refreshtoken.id.md)<!-- -->, [RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)<!-- -->&gt;
+<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[RefreshToken](./authentication-jwt.refreshtoken.md)<!-- -->, typeof [RefreshToken.prototype.id](./authentication-jwt.refreshtoken.id.md)<!-- -->, [RefreshTokenRelations](./authentication-jwt.refreshtokenrelations.md)
 
 ## Constructors
 

package/site/apidocs/authentication-jwt.user._constructor_.md

@@ -25,6 +25,6 @@ constructor(data?: Partial<User>);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | Partial&lt;[User](./authentication-jwt.user.md)<!-- -->&gt; |  |
+|  data | Partial&lt;[User](./authentication-jwt.user.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication-jwt.usercredentials._constructor_.md

@@ -25,6 +25,6 @@ constructor(data?: Partial<UserCredentials>);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  data | Partial&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->&gt; |  |
+|  data | Partial&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->&gt; | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication-jwt.usercredentialsrepository.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.usercredentialsrepository.html
 ```typescript
 export declare class UserCredentialsRepository extends DefaultCrudRepository<UserCredentials, typeof UserCredentials.prototype.id, UserCredentialsRelations> 
 ```
-<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [UserCredentials.prototype.id](./authentication-jwt.usercredentials.id.md)<!-- -->, [UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)<!-- -->&gt;
+<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[UserCredentials](./authentication-jwt.usercredentials.md)<!-- -->, typeof [UserCredentials.prototype.id](./authentication-jwt.usercredentials.id.md)<!-- -->, [UserCredentialsRelations](./authentication-jwt.usercredentialsrelations.md)
 
 ## Constructors
 

package/site/apidocs/authentication-jwt.userrepository.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication-jwt.userrepository.html
 ```typescript
 export declare class UserRepository extends DefaultCrudRepository<User, typeof User.prototype.id, UserRelations> 
 ```
-<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->, [UserRelations](./authentication-jwt.userrelations.md)<!-- -->&gt;
+<b>Extends:</b> [DefaultCrudRepository](./repository.defaultcrudrepository.md)<!-- -->&lt;[User](./authentication-jwt.user.md)<!-- -->, typeof [User.prototype.id](./authentication-jwt.user.id.md)<!-- -->, [UserRelations](./authentication-jwt.userrelations.md)
 
 ## Constructors
 

package/site/apidocs/authentication-passport.strategyadapter._constructor_.md

@@ -27,6 +27,6 @@ constructor(strategy: Strategy, name: string, userProfileFactory?: UserProfileFa
 |  --- | --- | --- |
 |  strategy | Strategy | instance of a class which implements a [passport-strategy](http://passportjs.org/)<!-- -->. |
 |  name | string |  |
-|  userProfileFactory | [UserProfileFactory](./authentication.userprofilefactory.md)<!-- -->&lt;U&gt; |  |
+|  userProfileFactory | [UserProfileFactory](./authentication.userprofilefactory.md)<!-- -->&lt;U&gt; | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication-passport.strategyadapter.authenticate.md

@@ -26,7 +26,7 @@ authenticate(request: Request, options?: AuthenticateOptions): Promise<UserProfi
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  request | Request | The incoming request. |
-|  options | AuthenticateOptions | Options passed through to strategy.authenticate. |
+|  options | AuthenticateOptions | <i>(Optional)</i> Options passed through to strategy.authenticate. |
 
 <b>Returns:</b>
 

package/site/apidocs/authentication.authenticateactionprovider._constructor_.md

@@ -29,6 +29,6 @@ constructor(getStrategies: Getter<AuthenticationStrategy | AuthenticationStrateg
 |  setCurrentUser | [Setter](./context.setter.md)<!-- -->&lt;[UserProfile](./security.userprofile.md)<!-- -->&gt; |  |
 |  setRedirectUrl | [Setter](./context.setter.md)<!-- -->&lt;string&gt; |  |
 |  setRedirectStatus | [Setter](./context.setter.md)<!-- -->&lt;number&gt; |  |
-|  options | [AuthenticationOptions](./authentication.authenticationoptions.md) |  |
+|  options | [AuthenticationOptions](./authentication.authenticationoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication.authenticateactionprovider.md

@@ -20,7 +20,7 @@ Provides the authentication action for a sequence
 ```typescript
 export declare class AuthenticateActionProvider implements Provider<AuthenticateFn> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticateFn](./authentication.authenticatefn.md)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticateFn](./authentication.authenticatefn.md)
 
 ## Example
 

package/site/apidocs/authentication.authenticationmiddlewareprovider.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authentication.authenticationmiddlewareprovider.h
 ```typescript
 export declare class AuthenticationMiddlewareProvider implements Provider<Middleware> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Middleware](./express.middleware.md)
 
 ## Constructors
 

package/site/apidocs/authentication.authenticationstrategyprovider._constructor_.md

@@ -26,6 +26,6 @@ constructor(authenticationStrategies: Getter<AuthenticationStrategy[]>, metadata
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  authenticationStrategies | [Getter](./context.getter.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\]&gt; |  |
-|  metadata | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined |  |
+|  metadata | [AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication.authenticationstrategyprovider.md

@@ -22,7 +22,7 @@ It declares an extension point to which all authentication strategy implementati
 ```typescript
 export declare class AuthenticationStrategyProvider implements Provider<AuthenticationStrategy[] | undefined> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)<!-- -->\[\] \| undefined&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationStrategy](./authentication.authenticationstrategy.md)
 
 ## Example
 

package/site/apidocs/authentication.authmetadataprovider._constructor_.md

@@ -27,6 +27,6 @@ constructor(controllerClass: Constructor<{}>, methodName: string, options?: Auth
 |  --- | --- | --- |
 |  controllerClass | [Constructor](./context.constructor.md)<!-- -->&lt;{}&gt; |  |
 |  methodName | string |  |
-|  options | [AuthenticationOptions](./authentication.authenticationoptions.md) |  |
+|  options | [AuthenticationOptions](./authentication.authenticationoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/authentication.authmetadataprovider.md

@@ -20,7 +20,7 @@ Provides authentication metadata of a controller method
 ```typescript
 export declare class AuthMetadataProvider implements Provider<AuthenticationMetadata[] | undefined> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationMetadata](./authentication.authenticationmetadata.md)<!-- -->\[\] \| undefined&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[AuthenticationMetadata](./authentication.authenticationmetadata.md)
 
 ## Example
 

package/site/apidocs/authorization.authorizationinterceptor._constructor_.md

@@ -25,6 +25,6 @@ constructor(options?: AuthorizationOptions);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [AuthorizationOptions](./authorization.authorizationoptions.md) |  |
+|  options | [AuthorizationOptions](./authorization.authorizationoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/authorization.authorizationinterceptor.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authorization.authorizationinterceptor.html
 ```typescript
 export declare class AuthorizationInterceptor implements Provider<Interceptor> 
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Interceptor](./context.interceptor.md)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[Interceptor](./context.interceptor.md)
 
 ## Constructors
 

package/site/apidocs/authorization.authorizemethoddecoratorfactory.md

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.authorization.authorizemethoddecoratorfactory.htm
 ```typescript
 export declare class AuthorizeMethodDecoratorFactory extends MethodDecoratorFactory<AuthorizationMetadata> 
 ```
-<b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)<!-- -->&lt;[AuthorizationMetadata](./authorization.authorizationmetadata.md)<!-- -->&gt;
+<b>Extends:</b> [MethodDecoratorFactory](./metadata.methoddecoratorfactory.md)<!-- -->&lt;[AuthorizationMetadata](./authorization.authorizationmetadata.md)
 
 ## Methods
 

package/site/apidocs/authorization.authorizemethoddecoratorfactory.mergewithown.md

@@ -25,8 +25,8 @@ protected mergeWithOwn(ownMetadata: MetadataMap<AuthorizationMetadata>, target:
 |  --- | --- | --- |
 |  ownMetadata | [MetadataMap](./metadata.metadatamap.md)<!-- -->&lt;[AuthorizationMetadata](./authorization.authorizationmetadata.md)<!-- -->&gt; |  |
 |  target | Object |  |
-|  methodName | string |  |
-|  methodDescriptor | TypedPropertyDescriptor&lt;any&gt; \| number |  |
+|  methodName | string | <i>(Optional)</i> |
+|  methodDescriptor | TypedPropertyDescriptor&lt;any&gt; \| number | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/boot.bootstrapper._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: Application & Bootable, projectRoot: string, bootOptions?: Boot
 |  --- | --- | --- |
 |  app | [Application](./core.application.md) & [Bootable](./boot.bootable.md) |  |
 |  projectRoot | string |  |
-|  bootOptions | [BootOptions](./boot.bootoptions.md) |  |
+|  bootOptions | [BootOptions](./boot.bootoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.bootstrapper.boot.md

@@ -25,8 +25,8 @@ boot(execOptions?: BootExecutionOptions, ctx?: Context): Promise<Context>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  execOptions | [BootExecutionOptions](./boot.bootexecutionoptions.md) | Execution options for boot. These determine the phases and booters that are run. |
-|  ctx | [Context](./context.context.md) | Optional Context to use to resolve bindings. This is primarily useful when running app.boot() again but with different settings (in particular phases) such as 'start' / 'stop'. Using a returned Context from a previous boot call allows DI to retrieve the same instances of Booters previously used as they are bound using a CONTEXT scope. This is important as Booter instances may maintain state. |
+|  execOptions | [BootExecutionOptions](./boot.bootexecutionoptions.md) | <i>(Optional)</i> Execution options for boot. These determine the phases and booters that are run. |
+|  ctx | [Context](./context.context.md) | <i>(Optional)</i> Optional Context to use to resolve bindings. This is primarily useful when running app.boot() again but with different settings (in particular phases) such as 'start' / 'stop'. Using a returned Context from a previous boot call allows DI to retrieve the same instances of Booters previously used as they are bound using a CONTEXT scope. This is important as Booter instances may maintain state. |
 
 <b>Returns:</b>
 

package/site/apidocs/boot.controllerbooter._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: Application, projectRoot: string, controllerConfig?: ArtifactOp
 |  --- | --- | --- |
 |  app | [Application](./core.application.md) |  |
 |  projectRoot | string |  |
-|  controllerConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  controllerConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.createbooterforcomponentapplication.md

@@ -26,7 +26,7 @@ export declare function createBooterForComponentApplication(componentApp: Applic
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  componentApp | [Application](./core.application.md) & [Bootable](./boot.bootable.md) | The application exposing a component |
-|  filter | [BindingFilter](./context.bindingfilter.md) | Binding filter to selected bindings to be added |
+|  filter | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> Binding filter to selected bindings to be added |
 
 <b>Returns:</b>
 

package/site/apidocs/boot.createcomponentapplicationbooterbinding.md

@@ -26,7 +26,7 @@ export declare function createComponentApplicationBooterBinding(componentApp: Ap
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  componentApp | [Application](./core.application.md) & [Bootable](./boot.bootable.md) | The application exposing a component |
-|  filter | [BindingFilter](./context.bindingfilter.md) | Binding filter to selected bindings to be added |
+|  filter | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> Binding filter to selected bindings to be added |
 
 <b>Returns:</b>
 

package/site/apidocs/boot.datasourcebooter._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, datasourceCon
 |  --- | --- | --- |
 |  app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) |  |
 |  projectRoot | string |  |
-|  datasourceConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  datasourceConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.interceptorproviderbooter._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: Application, projectRoot: string, interceptorConfig?: ArtifactO
 |  --- | --- | --- |
 |  app | [Application](./core.application.md) |  |
 |  projectRoot | string |  |
-|  interceptorConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  interceptorConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.lifecycleobserverbooter._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: Application, projectRoot: string, observerConfig?: ArtifactOpti
 |  --- | --- | --- |
 |  app | [Application](./core.application.md) |  |
 |  projectRoot | string |  |
-|  observerConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  observerConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.modelapibooter._constructor_.md

@@ -28,6 +28,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, getModelApiBu
 |  app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) |  |
 |  projectRoot | string |  |
 |  getModelApiBuilders | [Getter](./context.getter.md)<!-- -->&lt;[ModelApiBuilder](./model-api-builder.modelapibuilder.md)<!-- -->\[\]&gt; |  |
-|  booterConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  booterConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.modelbooter._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, modelConfig?:
 |  --- | --- | --- |
 |  app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) |  |
 |  projectRoot | string |  |
-|  modelConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  modelConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.repositorybooter._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: ApplicationWithRepositories, projectRoot: string, repositoryOpt
 |  --- | --- | --- |
 |  app | [ApplicationWithRepositories](./repository.applicationwithrepositories.md) |  |
 |  projectRoot | string |  |
-|  repositoryOptions | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  repositoryOptions | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/boot.servicebooter._constructor_.md

@@ -27,6 +27,6 @@ constructor(app: ApplicationWithServices, projectRoot: string, serviceConfig?: A
 |  --- | --- | --- |
 |  app | [ApplicationWithServices](./service-proxy.applicationwithservices.md) |  |
 |  projectRoot | string |  |
-|  serviceConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  serviceConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/context-explorer.contextexplorercomponent._constructor_.md

@@ -26,6 +26,6 @@ constructor(application: RestApplication, explorerConfig?: ContextExplorerConfig
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  application | [RestApplication](./rest.restapplication.md) |  |
-|  explorerConfig | [ContextExplorerConfig](./context-explorer.contextexplorerconfig.md) |  |
+|  explorerConfig | [ContextExplorerConfig](./context-explorer.contextexplorerconfig.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/context-explorer.contextgraph._constructor_.md

@@ -26,6 +26,6 @@ constructor(ctx: JSONObject, options?: ContextGraphOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctx | [JSONObject](./context.jsonobject.md) |  |
-|  options | [ContextGraphOptions](./context-explorer.contextgraphoptions.md) |  |
+|  options | [ContextGraphOptions](./context-explorer.contextgraphoptions.md) | <i>(Optional)</i> |
 
 

package/site/apidocs/context-explorer.rendergraph.md

@@ -29,7 +29,7 @@ export declare function renderGraph(graph: string, options?: {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  graph | string | A graph in dot format |
-|  options | { engine?: string; format?: string; } | Options for the rendering |
+|  options | { engine?: string; format?: string; } | <i>(Optional)</i> Options for the rendering |
 
 <b>Returns:</b>
 

package/site/apidocs/context.asglobalinterceptor.md

@@ -25,7 +25,7 @@ export declare function asGlobalInterceptor(group?: string): BindingTemplate;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  group | string | Group for ordering the interceptor |
+|  group | string | <i>(Optional)</i> Group for ordering the interceptor |
 
 <b>Returns:</b>
 

package/site/apidocs/context.asresolutionoptions.md

@@ -25,7 +25,7 @@ export declare function asResolutionOptions(optionsOrSession?: ResolutionOptions
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  optionsOrSession | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | resolution options or session |
+|  optionsOrSession | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | <i>(Optional)</i> resolution options or session |
 
 <b>Returns:</b>
 

package/site/apidocs/context.asserttargettype.md

@@ -27,7 +27,7 @@ export declare function assertTargetType(injection: Readonly<Injection>, expecte
 |  --- | --- | --- |
 |  injection | Readonly&lt;[Injection](./context.injection.md)<!-- -->&gt; | Injection information |
 |  expectedType | Function | Expected type |
-|  expectedTypeName | string | Name of the expected type to be used in the error |
+|  expectedTypeName | string | <i>(Optional)</i> Name of the expected type to be used in the error |
 
 <b>Returns:</b>
 

package/site/apidocs/context.binding._constructor_.md

@@ -26,6 +26,6 @@ constructor(key: BindingAddress<T>, isLocked?: boolean);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;T&gt; |  |
-|  isLocked | boolean |  |
+|  isLocked | boolean | <i>(Optional)</i> |
 
 

package/site/apidocs/context.binding.getvalue.md

@@ -30,7 +30,7 @@ getValue(ctx: Context, session?: ResolutionSession): ValueOrPromise<T>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context for the resolution |
-|  session | [ResolutionSession](./context.resolutionsession.md) | Optional session for binding and dependency resolution |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Optional session for binding and dependency resolution |
 
 <b>Returns:</b>
 

package/site/apidocs/context.binding.getvalue_1.md

@@ -26,7 +26,7 @@ getValue(ctx: Context, options?: ResolutionOptions): ValueOrPromise<T | undefine
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context for the resolution |
-|  options | [ResolutionOptions](./context.resolutionoptions.md) | Optional options for binding and dependency resolution |
+|  options | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Optional options for binding and dependency resolution |
 
 <b>Returns:</b>
 

package/site/apidocs/context.binding.inspect.md

@@ -25,7 +25,7 @@ inspect(options?: BindingInspectOptions): JSONObject;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [BindingInspectOptions](./context.bindinginspectoptions.md) | Options to control what information should be included |
+|  options | [BindingInspectOptions](./context.bindinginspectoptions.md) | <i>(Optional)</i> Options to control what information should be included |
 
 <b>Returns:</b>
 

package/site/apidocs/context.bindingkey.buildkeyforconfig.md

@@ -25,7 +25,7 @@ static buildKeyForConfig<T>(key?: BindingAddress): BindingAddress<T>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  key | [BindingAddress](./context.bindingaddress.md) | Key of the target binding to be configured |
+|  key | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> Key of the target binding to be configured |
 
 <b>Returns:</b>
 

package/site/apidocs/context.bindingkey.create.md

@@ -26,7 +26,7 @@ static create<V>(key: string, propertyPath?: string): BindingKey<V>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | string | The binding key. When propertyPath is not provided, the key is allowed to contain propertyPath as encoded via <code>BindingKey#toString()</code> |
-|  propertyPath | string | Optional path to a deep property of the bound value. |
+|  propertyPath | string | <i>(Optional)</i> Optional path to a deep property of the bound value. |
 
 <b>Returns:</b>
 

package/site/apidocs/context.bindingkey.generate.md

@@ -27,7 +27,7 @@ static generate<T>(namespace?: string): BindingKey<T>;
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  namespace | string | Namespace for the binding |
+|  namespace | string | <i>(Optional)</i> Namespace for the binding |
 
 <b>Returns:</b>
 

package/site/apidocs/context.bindingtemplatefor.md

@@ -26,7 +26,7 @@ export declare function bindingTemplateFor<T>(cls: Constructor<T | Provider<T>>
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  cls | [Constructor](./context.constructor.md)<!-- -->&lt;T \| [Provider](./context.provider.md)<!-- -->&lt;T&gt;&gt; \| [DynamicValueProviderClass](./context.dynamicvalueproviderclass.md)<!-- -->&lt;T&gt; | A class with optional <code>@injectable</code> |
-|  options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) |  |
+|  options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/context.comparebindingsbytag.md

@@ -25,8 +25,8 @@ export declare function compareBindingsByTag(phaseTagName?: string, orderOfPhase
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  phaseTagName | string | Name of the binding tag for phase |
-|  orderOfPhases | (string \| symbol)\[\] | An array of phase names as the predefined order |
+|  phaseTagName | string | <i>(Optional)</i> Name of the binding tag for phase |
+|  orderOfPhases | (string \| symbol)\[\] | <i>(Optional)</i> An array of phase names as the predefined order |
 
 <b>Returns:</b>
 

package/site/apidocs/context.comparebyorder.md

@@ -27,7 +27,7 @@ export declare function compareByOrder(a: string | symbol | undefined | null, b:
 |  --- | --- | --- |
 |  a | string \| symbol \| undefined \| null | First value |
 |  b | string \| symbol \| undefined \| null | Second value |
-|  order | (string \| symbol)\[\] | An array of values as the predefined order |
+|  order | (string \| symbol)\[\] | <i>(Optional)</i> An array of values as the predefined order |
 
 <b>Returns:</b>
 

package/site/apidocs/context.configbindingkeyfor.md

@@ -26,7 +26,7 @@ export declare function configBindingKeyFor<ConfigValueType = unknown>(key: Bind
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md) | Binding key for the target binding |
-|  propertyPath | string | Property path for the configuration |
+|  propertyPath | string | <i>(Optional)</i> Property path for the configuration |
 
 <b>Returns:</b>
 

package/site/apidocs/context.configurationresolver.getconfigasvalueorpromise.md

@@ -26,8 +26,8 @@ getConfigAsValueOrPromise<ConfigValueType>(key: BindingAddress<unknown>, propert
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt; | Binding key |
-|  propertyPath | string | Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>config</code> object will be returned. |
-|  resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | Options for the resolution. - optional: if not set or set to <code>true</code>, <code>undefined</code> will be returned if no corresponding value is found. Otherwise, an error will be thrown. |
+|  propertyPath | string | <i>(Optional)</i> Property path for the option. For example, <code>x.y</code> requests for <code>&lt;config&gt;.x.y</code>. If not set, the <code>config</code> object will be returned. |
+|  resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for the resolution. - optional: if not set or set to <code>true</code>, <code>undefined</code> will be returned if no corresponding value is found. Otherwise, an error will be thrown. |
 
 <b>Returns:</b>
 

package/site/apidocs/context.context._constructor_.md

@@ -25,8 +25,8 @@ constructor(_parent?: Context | string, name?: string);
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  \_parent | [Context](./context.context.md) \| string | The optional parent context |
-|  name | string | Name of the context. If not provided, a unique identifier will be generated as the name. |
+|  \_parent | [Context](./context.context.md) \| string | <i>(Optional)</i> The optional parent context |
+|  name | string | <i>(Optional)</i> Name of the context. If not provided, a unique identifier will be generated as the name. |
 
 ## Example
 

package/site/apidocs/context.context._mergewithparent.md

@@ -24,7 +24,7 @@ protected _mergeWithParent<ValueType>(childList: Readonly<Binding<ValueType>>[],
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  childList | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;&gt;\[\] |  |
-|  parentList | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;&gt;\[\] |  |
+|  parentList | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;&gt;\[\] | <i>(Optional)</i> |
 
 <b>Returns:</b>
 

package/site/apidocs/context.context.configure.md

@@ -27,7 +27,7 @@ configure<ConfigValueType = BoundValue>(key?: BindingAddress): Binding<ConfigVal
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  key | [BindingAddress](./context.bindingaddress.md) | The key for the binding to be configured |
+|  key | [BindingAddress](./context.bindingaddress.md) | <i>(Optional)</i> The key for the binding to be configured |
 
 <b>Returns:</b>
 

package/site/apidocs/context.context.createview.md

@@ -26,8 +26,8 @@ createView<T = unknown>(filter: BindingFilter, comparator?: BindingComparator, o
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  filter | [BindingFilter](./context.bindingfilter.md) | A function to match bindings |
-|  comparator | [BindingComparator](./context.bindingcomparator.md) | A function to sort matched bindings |
-|  options | Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, 'session'&gt; | Resolution options |
+|  comparator | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> A function to sort matched bindings |
+|  options | Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, 'session'&gt; | <i>(Optional)</i> Resolution options |
 
 <b>Returns:</b>