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/context.contextsubscriptionmanager.notifyobservers.md CHANGED Viewed

@@ -26,7 +26,7 @@ protected notifyObservers(event: ContextEvent, observers?: Set<ContextEventObser
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  event | [ContextEvent](./context.contextevent.md) | Context event |
-|  observers | Set&lt;[ContextEventObserver](./context.contexteventobserver.md)<!-- -->&gt; \| undefined | Current set of context observers |
+|  observers | Set&lt;[ContextEventObserver](./context.contexteventobserver.md)<!-- -->&gt; \| undefined | <i>(Optional)</i> Current set of context observers |
 <b>Returns:</b>

package/site/apidocs/context.contextsubscriptionmanager.waituntilpendingnotificationsdone.md CHANGED Viewed

@@ -27,7 +27,7 @@ waitUntilPendingNotificationsDone(timeout?: number): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  timeout | number |  |
+|  timeout | number | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/context.contextview._constructor_.md CHANGED Viewed

@@ -27,7 +27,7 @@ constructor(context: Context, filter: BindingFilter, comparator?: BindingCompara
 |  --- | --- | --- |
 |  context | [Context](./context.context.md) | Context object to watch |
 |  filter | [BindingFilter](./context.bindingfilter.md) | Binding filter to match bindings of interest |
-|  comparator | [BindingComparator](./context.bindingcomparator.md) \| undefined | Comparator to sort the matched bindings |
-|  resolutionOptions | Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"&gt; \| undefined |  |
+|  comparator | [BindingComparator](./context.bindingcomparator.md) \| undefined | <i>(Optional)</i> Comparator to sort the matched bindings |
+|  resolutionOptions | Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"&gt; \| undefined | <i>(Optional)</i> |

package/site/apidocs/context.contextview.asgetter.md CHANGED Viewed

@@ -25,7 +25,7 @@ asGetter(session?: ResolutionOptionsOrSession): Getter<T[]>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) |  |
+|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/context.contextview.resolve.md CHANGED Viewed

@@ -25,7 +25,7 @@ resolve(session?: ResolutionOptionsOrSession): ValueOrPromise<T[]>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | Resolution session |
+|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | <i>(Optional)</i> Resolution session |
 <b>Returns:</b>

package/site/apidocs/context.contextview.singlevalue.md CHANGED Viewed

@@ -25,7 +25,7 @@ singleValue(session?: ResolutionOptionsOrSession): Promise<T | undefined>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) |  |
+|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/context.contextview.values.md CHANGED Viewed

@@ -25,7 +25,7 @@ values(session?: ResolutionOptionsOrSession): Promise<T[]>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) |  |
+|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/context.createbindingfromclass.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function createBindingFromClass<T>(cls: Constructor<T | Provider<
 |  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. It can be either a plain class, a value provider class, or a dynamic value provider class |
-|  options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) | Options to customize the binding key |
+|  options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> Options to customize the binding key |
 <b>Returns:</b>

package/site/apidocs/context.createproxywithinterceptors.md CHANGED Viewed

@@ -26,9 +26,9 @@ export declare function createProxyWithInterceptors<T extends object>(target: T,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | T | Target class or object |
-|  context | [Context](./context.context.md) | Context object |
-|  session | [ResolutionSession](./context.resolutionsession.md) | Resolution session |
-|  source | [InvocationSource](./context.invocationsource.md) | Invocation source |
+|  context | [Context](./context.context.md) | <i>(Optional)</i> Context object |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Resolution session |
+|  source | [InvocationSource](./context.invocationsource.md) | <i>(Optional)</i> Invocation source |
 <b>Returns:</b>

package/site/apidocs/context.createviewgetter.md CHANGED Viewed

@@ -27,7 +27,7 @@ export declare function createViewGetter<T = unknown>(ctx: Context, bindingFilte
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context object |
 |  bindingFilter | [BindingFilter](./context.bindingfilter.md) | A function to match bindings |
-|  session | [ResolutionSession](./context.resolutionsession.md) | Resolution session |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Resolution session |
 <b>Returns:</b>

package/site/apidocs/context.createviewgetter_1.md CHANGED Viewed

@@ -27,8 +27,8 @@ export declare function createViewGetter<T = unknown>(ctx: Context, bindingFilte
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context object |
 |  bindingFilter | [BindingFilter](./context.bindingfilter.md) | A function to match bindings |
-|  bindingComparator | [BindingComparator](./context.bindingcomparator.md) | A function to compare two bindings |
-|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | Resolution session |
+|  bindingComparator | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> A function to compare two bindings |
+|  session | [ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) | <i>(Optional)</i> Resolution session |
 <b>Returns:</b>

package/site/apidocs/context.defaultconfigurationresolver.getconfigasvalueorpromise.md CHANGED Viewed

@@ -24,8 +24,8 @@ getConfigAsValueOrPromise<ConfigValueType>(key: BindingAddress<unknown>, propert
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt; |  |
-|  propertyPath | string |  |
-|  resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) |  |
+|  propertyPath | string | <i>(Optional)</i> |
+|  resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/context.describeinjectedarguments.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function describeInjectedArguments(target: Object, method?: strin
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  target | Object | The target class for constructor or static methods, or the prototype for instance methods |
-|  method | string | Method name, undefined for constructor |
+|  method | string | <i>(Optional)</i> Method name, undefined for constructor |
 <b>Returns:</b>

package/site/apidocs/context.filterbykey.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function filterByKey(keyPattern?: string | RegExp | BindingFilter
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  keyPattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | Binding key/wildcard, regexp, or a filter function |
+|  keyPattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> Binding key/wildcard, regexp, or a filter function |
 <b>Returns:</b>

package/site/apidocs/context.genericinterceptorchain._constructor__1.md CHANGED Viewed

@@ -27,6 +27,6 @@ constructor(context: C, filter: BindingFilter, comparator?: BindingComparator);
 |  --- | --- | --- |
 |  context | C | Context object |
 |  filter | [BindingFilter](./context.bindingfilter.md) | A binding filter function to select interceptors |
-|  comparator | [BindingComparator](./context.bindingcomparator.md) | An optional comparator to sort matched interceptor bindings |
+|  comparator | [BindingComparator](./context.bindingcomparator.md) | <i>(Optional)</i> An optional comparator to sort matched interceptor bindings |

package/site/apidocs/context.genericinterceptorchain.invokeinterceptors.md CHANGED Viewed

@@ -25,7 +25,7 @@ invokeInterceptors(finalHandler?: Next): ValueOrPromise<InvocationResult>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  finalHandler | [Next](./context.next.md) |  |
+|  finalHandler | [Next](./context.next.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/context.globalinterceptor.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function globalInterceptor(group?: string, ...specs: BindingSpec[
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  group | string | Group for ordering the interceptor |
+|  group | string | <i>(Optional)</i> Group for ordering the interceptor |
 |  specs | [BindingSpec](./context.bindingspec.md)<!-- -->\[\] | Extra binding specs |
 <b>Returns:</b>

package/site/apidocs/context.injectionmetadata.md CHANGED Viewed

@@ -20,7 +20,7 @@ An object to provide metadata for `@inject`
 ```typescript
 export interface InjectionMetadata extends Omit<ResolutionOptions, 'session'>
 ```
-<b>Extends:</b> Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, 'session'&gt;
+<b>Extends:</b> Omit&lt;[ResolutionOptions](./context.resolutionoptions.md)
 ## Properties

package/site/apidocs/context.instantiateclass.md CHANGED Viewed

@@ -29,8 +29,8 @@ export declare function instantiateClass<T>(ctor: Constructor<T>, ctx: Context,
 |  --- | --- | --- |
 |  ctor | [Constructor](./context.constructor.md)<!-- -->&lt;T&gt; | The class constructor to call. |
 |  ctx | [Context](./context.context.md) | The context containing values for <code>@inject</code> resolution |
-|  session | [ResolutionSession](./context.resolutionsession.md) | Optional session for binding and dependency resolution |
-|  nonInjectedArgs | any\[\] | Optional array of args for non-injected parameters |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Optional session for binding and dependency resolution |
+|  nonInjectedArgs | any\[\] | <i>(Optional)</i> Optional array of args for non-injected parameters |
 <b>Returns:</b>

package/site/apidocs/context.interceptionhandler._constructor_.md CHANGED Viewed

@@ -25,8 +25,8 @@ constructor(context?: Context, session?: ResolutionSession | undefined, source?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  context | [Context](./context.context.md) |  |
-|  session | [ResolutionSession](./context.resolutionsession.md) \| undefined |  |
-|  source | [InvocationSource](./context.invocationsource.md)<!-- -->&lt;unknown&gt; \| undefined |  |
+|  context | [Context](./context.context.md) | <i>(Optional)</i> |
+|  session | [ResolutionSession](./context.resolutionsession.md) \| undefined | <i>(Optional)</i> |
+|  source | [InvocationSource](./context.invocationsource.md)<!-- -->&lt;unknown&gt; \| undefined | <i>(Optional)</i> |

package/site/apidocs/context.interceptionhandler.md CHANGED Viewed

@@ -22,7 +22,7 @@ See https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global\_Objec
 ```typescript
 export declare class InterceptionHandler<T extends object> implements ProxyHandler<T>
 ```
-<b>Implements:</b> ProxyHandler&lt;T&gt;
+<b>Implements:</b> ProxyHandler
 ## Constructors

package/site/apidocs/context.interceptor.md CHANGED Viewed

@@ -20,6 +20,6 @@ Interceptor function to intercept method invocations
 ```typescript
 export interface Interceptor extends GenericInterceptor<InvocationContext>
 ```
-<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- -->&lt;[InvocationContext](./context.invocationcontext.md)<!-- -->&gt;
+<b>Extends:</b> [GenericInterceptor](./context.genericinterceptor.md)<!-- -->&lt;[InvocationContext](./context.invocationcontext.md)

package/site/apidocs/context.invocationcontext._constructor_.md CHANGED Viewed

@@ -29,6 +29,6 @@ constructor(parent: Context, target: object, methodName: string, args: Invocatio
 |  target | object | Target class (for static methods) or prototype/object (for instance methods) |
 |  methodName | string | Method name |
 |  args | [InvocationArgs](./context.invocationargs.md) | An array of arguments |
-|  source | [InvocationSource](./context.invocationsource.md)<!-- -->&lt;unknown&gt; \| undefined |  |
+|  source | [InvocationSource](./context.invocationsource.md)<!-- -->&lt;unknown&gt; \| undefined | <i>(Optional)</i> |

package/site/apidocs/context.invocationcontext.invoketargetmethod.md CHANGED Viewed

@@ -25,7 +25,7 @@ invokeTargetMethod(options?: InvocationOptions): any;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [InvocationOptions](./context.invocationoptions.md) | Options for the invocation |
+|  options | [InvocationOptions](./context.invocationoptions.md) | <i>(Optional)</i> Options for the invocation |
 <b>Returns:</b>

package/site/apidocs/context.invokemethod.md CHANGED Viewed

@@ -28,8 +28,8 @@ export declare function invokeMethod(target: object, method: string, ctx: Contex
 |  target | object | Target of the method, it will be the class for a static method, and instance or class prototype for a prototype method |
 |  method | string | Name of the method |
 |  ctx | [Context](./context.context.md) | Context object |
-|  nonInjectedArgs | [InvocationArgs](./context.invocationargs.md) | Optional array of args for non-injected parameters |
-|  options | [InvocationOptions](./context.invocationoptions.md) | Options for the invocation |
+|  nonInjectedArgs | [InvocationArgs](./context.invocationargs.md) | <i>(Optional)</i> Optional array of args for non-injected parameters |
+|  options | [InvocationOptions](./context.invocationoptions.md) | <i>(Optional)</i> Options for the invocation |
 <b>Returns:</b>

package/site/apidocs/context.invokemethodwithinterceptors.md CHANGED Viewed

@@ -29,7 +29,7 @@ export declare function invokeMethodWithInterceptors(context: Context, target: o
 |  target | object | Target class (for static methods) or object (for instance methods) |
 |  methodName | string | Method name |
 |  args | [InvocationArgs](./context.invocationargs.md) | An array of argument values |
-|  options | [InvocationOptions](./context.invocationoptions.md) | Options for the invocation |
+|  options | [InvocationOptions](./context.invocationoptions.md) | <i>(Optional)</i> Options for the invocation |
 <b>Returns:</b>

package/site/apidocs/context.isbindingtagfilter.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function isBindingTagFilter(filter?: BindingFilter): filter is Bi
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  filter | [BindingFilter](./context.bindingfilter.md) | A BindingFilter function |
+|  filter | [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> A BindingFilter function |
 <b>Returns:</b>

package/site/apidocs/context.jsonarray.md CHANGED Viewed

@@ -20,6 +20,6 @@ JSON array
 ```typescript
 export interface JSONArray extends Array<JSONValue>
 ```
-<b>Extends:</b> Array&lt;[JSONValue](./context.jsonvalue.md)<!-- -->&gt;
+<b>Extends:</b> Array&lt;[JSONValue](./context.jsonvalue.md)

package/site/apidocs/context.jsonobject.md CHANGED Viewed

@@ -20,6 +20,6 @@ JSON object
 ```typescript
 export interface JSONObject extends Record<string, JSONValue>
 ```
-<b>Extends:</b> Record&lt;string, [JSONValue](./context.jsonvalue.md)<!-- -->&gt;
+<b>Extends:</b> Record&lt;string, [JSONValue](./context.jsonvalue.md)

package/site/apidocs/context.proxysource.md CHANGED Viewed

@@ -20,7 +20,7 @@ Invocation source for injected proxies. It wraps a snapshot of the `ResolutionSe
 ```typescript
 export declare class ProxySource implements InvocationSource<ResolutionSession>
 ```
-<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- -->&lt;[ResolutionSession](./context.resolutionsession.md)<!-- -->&gt;
+<b>Implements:</b> [InvocationSource](./context.invocationsource.md)<!-- -->&lt;[ResolutionSession](./context.resolutionsession.md)
 ## Constructors

package/site/apidocs/context.registerinterceptor.md CHANGED Viewed

@@ -27,7 +27,7 @@ export declare function registerInterceptor(ctx: Context, interceptor: Intercept
 |  --- | --- | --- |
 |  ctx | [Context](./context.context.md) | Context object |
 |  interceptor | [Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;[Interceptor](./context.interceptor.md)<!-- -->&gt;&gt; | An interceptor function or provider class |
-|  options | [InterceptorBindingOptions](./context.interceptorbindingoptions.md) | Options for the interceptor binding |
+|  options | [InterceptorBindingOptions](./context.interceptorbindingoptions.md) | <i>(Optional)</i> Options for the interceptor binding |
 <b>Returns:</b>

package/site/apidocs/context.resolutionsession.fork.md CHANGED Viewed

@@ -25,7 +25,7 @@ static fork(session?: ResolutionSession): ResolutionSession | undefined;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  session | [ResolutionSession](./context.resolutionsession.md) | The current session |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> The current session |
 <b>Returns:</b>

package/site/apidocs/context.resolutionsession.runwithbinding.md CHANGED Viewed

@@ -27,7 +27,7 @@ static runWithBinding(action: ResolutionAction, binding: Readonly<Binding>, sess
 |  --- | --- | --- |
 |  action | [ResolutionAction](./context.resolutionaction.md) | A function to do some work with the resolution session |
 |  binding | Readonly&lt;[Binding](./context.binding.md)<!-- -->&gt; | The current binding |
-|  session | [ResolutionSession](./context.resolutionsession.md) | The current resolution session |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> The current resolution session |
 <b>Returns:</b>

package/site/apidocs/context.resolutionsession.runwithinjection.md CHANGED Viewed

@@ -27,7 +27,7 @@ static runWithInjection(action: ResolutionAction, injection: Readonly<Injection>
 |  --- | --- | --- |
 |  action | [ResolutionAction](./context.resolutionaction.md) | A function to do some work with the resolution session |
 |  injection | Readonly&lt;[Injection](./context.injection.md)<!-- -->&gt; |  |
-|  session | [ResolutionSession](./context.resolutionsession.md) | The current resolution session |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> The current resolution session |
 <b>Returns:</b>

package/site/apidocs/context.resolveinjectedarguments.md CHANGED Viewed

@@ -30,8 +30,8 @@ export declare function resolveInjectedArguments(target: object, method: string,
 |  target | object | The class for constructor injection or prototype for method injection |
 |  method | string | The method name. If set to '', the constructor will be used. |
 |  ctx | [Context](./context.context.md) | The context containing values for <code>@inject</code> resolution |
-|  session | [ResolutionSession](./context.resolutionsession.md) | Optional session for binding and dependency resolution |
-|  nonInjectedArgs | any\[\] | Optional array of args for non-injected parameters |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Optional session for binding and dependency resolution |
+|  nonInjectedArgs | any\[\] | <i>(Optional)</i> Optional array of args for non-injected parameters |
 <b>Returns:</b>

package/site/apidocs/context.resolveinjectedproperties.md CHANGED Viewed

@@ -29,7 +29,7 @@ export declare function resolveInjectedProperties(constructor: Function, ctx: Co
 |  --- | --- | --- |
 |  constructor | Function | The class for which properties should be resolved. |
 |  ctx | [Context](./context.context.md) | The context containing values for <code>@inject</code> 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.sortbindingsbyphase.md CHANGED Viewed

@@ -26,8 +26,8 @@ export declare function sortBindingsByPhase<T = unknown>(bindings: Readonly<Bind
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  bindings | Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;T&gt;&gt;\[\] | An array of bindings |
-|  phaseTagName | string | Tag name for phase, for example, we can use the value <code>'a'</code> of tag <code>order</code> as the phase name for <code>binding.tag({order: 'a'})</code>. |
-|  orderOfPhases | (string \| symbol)\[\] | An array of phase names as the predefined order |
+|  phaseTagName | string | <i>(Optional)</i> Tag name for phase, for example, we can use the value <code>'a'</code> of tag <code>order</code> as the phase name for <code>binding.tag({order: 'a'})</code>. |
+|  orderOfPhases | (string \| symbol)\[\] | <i>(Optional)</i> An array of phase names as the predefined order |
 <b>Returns:</b>

package/site/apidocs/context.trycatchfinally.md CHANGED Viewed

@@ -26,8 +26,8 @@ export declare function tryCatchFinally<T>(action: () => ValueOrPromise<T>, erro
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  action | () =&gt; [ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;T&gt; | A function that returns a promise or a value |
-|  errorAction | (err: unknown) =&gt; T \| never | A function to be called once the action is rejected (synchronously or asynchronously). It must either return a new value or throw an error. |
-|  finalAction | () =&gt; void | A function to be called once the action is fulfilled or rejected (synchronously or asynchronously) |
+|  errorAction | (err: unknown) =&gt; T \| never | <i>(Optional)</i> A function to be called once the action is rejected (synchronously or asynchronously). It must either return a new value or throw an error. |
+|  finalAction | () =&gt; void | <i>(Optional)</i> A function to be called once the action is fulfilled or rejected (synchronously or asynchronously) |
 <b>Returns:</b>

package/site/apidocs/core.addextension.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function addExtension(context: Context, extensionPointName: strin
 |  context | [Context](./context.context.md) | Context object |
 |  extensionPointName | string | Name of the extension point |
 |  extensionClass | [Constructor](./context.constructor.md)<!-- -->&lt;unknown&gt; | Class or a provider for an extension |
-|  options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) | Options Options for the creation of binding from class |
+|  options | [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> Options Options for the creation of binding from class |
 <b>Returns:</b>

package/site/apidocs/core.application._constructor__1.md CHANGED Viewed

@@ -25,7 +25,7 @@ constructor(config?: ApplicationConfig, parent?: Context);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  config | [ApplicationConfig](./core.applicationconfig.md) | Application configuration |
-|  parent | [Context](./context.context.md) | Parent context |
+|  config | [ApplicationConfig](./core.applicationconfig.md) | <i>(Optional)</i> Application configuration |
+|  parent | [Context](./context.context.md) | <i>(Optional)</i> Parent context |

package/site/apidocs/core.application.component.md CHANGED Viewed

@@ -26,7 +26,7 @@ component<T extends Component = Component>(componentCtor: Constructor<T>, nameOr
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  componentCtor | [Constructor](./context.constructor.md)<!-- -->&lt;T&gt; | The component class to add. |
-|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | Optional component name or options, default to the class name |
+|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> Optional component name or options, default to the class name |
 <b>Returns:</b>

package/site/apidocs/core.application.controller.md CHANGED Viewed

@@ -26,7 +26,7 @@ controller<T>(controllerCtor: ControllerClass<T>, nameOrOptions?: string | Bindi
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  controllerCtor | [ControllerClass](./core.controllerclass.md)<!-- -->&lt;T&gt; | The controller class (constructor function). |
-|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) |  |
+|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/core.application.interceptor.md CHANGED Viewed

@@ -26,7 +26,7 @@ interceptor(interceptor: Interceptor | Constructor<Provider<Interceptor>>, nameO
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  interceptor | [Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;[Interceptor](./context.interceptor.md)<!-- -->&gt;&gt; | An interceptor function or provider class |
-|  nameOrOptions | string \| [InterceptorBindingOptions](./context.interceptorbindingoptions.md) | Binding name or options |
+|  nameOrOptions | string \| [InterceptorBindingOptions](./context.interceptorbindingoptions.md) | <i>(Optional)</i> Binding name or options |
 <b>Returns:</b>

package/site/apidocs/core.application.lifecycleobserver.md CHANGED Viewed

@@ -26,7 +26,7 @@ lifeCycleObserver<T extends LifeCycleObserver>(ctor: Constructor<T>, nameOrOptio
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctor | [Constructor](./context.constructor.md)<!-- -->&lt;T&gt; | A class implements LifeCycleObserver |
-|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | Optional name or options for the life cycle observer |
+|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> Optional name or options for the life cycle observer |
 <b>Returns:</b>

package/site/apidocs/core.application.server.md CHANGED Viewed

@@ -26,7 +26,7 @@ server<T extends Server>(ctor: Constructor<T>, nameOrOptions?: string | BindingF
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  ctor | [Constructor](./context.constructor.md)<!-- -->&lt;T&gt; |  |
-|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | Optional override for name or options. |
+|  nameOrOptions | string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) | <i>(Optional)</i> Optional override for name or options. |
 <b>Returns:</b>

package/site/apidocs/core.application.service.md CHANGED Viewed

@@ -26,7 +26,7 @@ service<S>(cls: ServiceOrProviderClass<S>, nameOrOptions?: string | ServiceOptio
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  cls | [ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- -->&lt;S&gt; | The service or provider class |
-|  nameOrOptions | string \| [ServiceOptions](./core.serviceoptions.md) |  |
+|  nameOrOptions | string \| [ServiceOptions](./core.serviceoptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/core.createservicebinding.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function createServiceBinding<S>(cls: ServiceOrProviderClass<S>,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  cls | [ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- -->&lt;S&gt; | Service class or provider |
-|  options | [ServiceOptions](./core.serviceoptions.md) | Service options |
+|  options | [ServiceOptions](./core.serviceoptions.md) | <i>(Optional)</i> Service options |
 <b>Returns:</b>

package/site/apidocs/core.extensions.list.md CHANGED Viewed

@@ -25,8 +25,8 @@ function list(extensionPointName?: string, metadata?: InjectionMetadata): (targe
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  extensionPointName | string | Name of the extension point. If not supplied, we use the <code>name</code> tag from the extension point binding or the class name of the extension point class. If a class needs to inject extensions from multiple extension points, use different <code>extensionPointName</code> for different types of extensions. |
-|  metadata | [InjectionMetadata](./context.injectionmetadata.md) | Optional injection metadata |
+|  extensionPointName | string | <i>(Optional)</i> Name of the extension point. If not supplied, we use the <code>name</code> tag from the extension point binding or the class name of the extension point class. If a class needs to inject extensions from multiple extension points, use different <code>extensionPointName</code> for different types of extensions. |
+|  metadata | [InjectionMetadata](./context.injectionmetadata.md) | <i>(Optional)</i> Optional injection metadata |
 <b>Returns:</b>

package/site/apidocs/core.extensions.view.md CHANGED Viewed

@@ -25,8 +25,8 @@ function view(extensionPointName?: string, metadata?: InjectionMetadata): (targe
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  extensionPointName | string | Name of the extension point. If not supplied, we use the <code>name</code> tag from the extension point binding or the class name of the extension point class. If a class needs to inject extensions from multiple extension points, use different <code>extensionPointName</code> for different types of extensions. |
-|  metadata | [InjectionMetadata](./context.injectionmetadata.md) | Optional injection metadata |
+|  extensionPointName | string | <i>(Optional)</i> Name of the extension point. If not supplied, we use the <code>name</code> tag from the extension point binding or the class name of the extension point class. If a class needs to inject extensions from multiple extension points, use different <code>extensionPointName</code> for different types of extensions. |
+|  metadata | [InjectionMetadata](./context.injectionmetadata.md) | <i>(Optional)</i> Optional injection metadata |
 <b>Returns:</b>

package/site/apidocs/core.lifecycleobserverregistry._constructor_.md CHANGED Viewed

@@ -27,6 +27,6 @@ constructor(context: Context, observersView: ContextView<LifeCycleObserver>, opt
 |  --- | --- | --- |
 |  context | [Context](./context.context.md) |  |
 |  observersView | [ContextView](./context.contextview.md)<!-- -->&lt;[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt; |  |
-|  options | [LifeCycleObserverOptions](./core.lifecycleobserveroptions.md) |  |
+|  options | [LifeCycleObserverOptions](./core.lifecycleobserveroptions.md) | <i>(Optional)</i> |

package/site/apidocs/core.lifecycleobserverregistry.notifygroups.md CHANGED Viewed

@@ -27,7 +27,7 @@ protected notifyGroups(events: (keyof LifeCycleObserver)[], groups: LifeCycleObs
 |  --- | --- | --- |
 |  events | (keyof [LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->)\[\] | Event names |
 |  groups | [LifeCycleObserverGroup](./core.lifecycleobservergroup.md)<!-- -->\[\] | Observer groups |
-|  reverse | boolean |  |
+|  reverse | boolean | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/core.service.md CHANGED Viewed

@@ -25,8 +25,8 @@ export declare function service(serviceInterface?: ServiceInterface, metadata?:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  serviceInterface | [ServiceInterface](./core.serviceinterface.md) | Interface for the service. It can be in one of the following forms:<!-- -->- A class, such as MyService - A string that identifies the interface, such as <code>'MyService'</code> - A symbol that identifies the interface, such as <code>Symbol('MyService')</code>If not provided, the value is inferred from the design:type of the parameter or property |
-|  metadata | [InjectionMetadata](./context.injectionmetadata.md) |  |
+|  serviceInterface | [ServiceInterface](./core.serviceinterface.md) | <i>(Optional)</i> Interface for the service. It can be in one of the following forms:<!-- -->- A class, such as MyService - A string that identifies the interface, such as <code>'MyService'</code> - A symbol that identifies the interface, such as <code>Symbol('MyService')</code>If not provided, the value is inferred from the design:type of the parameter or property |
+|  metadata | [InjectionMetadata](./context.injectionmetadata.md) | <i>(Optional)</i> |
 <b>Returns:</b>

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

@@ -25,7 +25,7 @@ export declare function asMiddleware(options?: MiddlewareBindingOptions): Bindin
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | Options to configure the binding |
+|  options | [MiddlewareBindingOptions](./express.middlewarebindingoptions.md) | <i>(Optional)</i> Options to configure the binding |
 <b>Returns:</b>

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

@@ -26,8 +26,8 @@ export declare function buildName<CFG>(middlewareFactory: ExpressMiddlewareFacto
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Express middleware factory function |
-|  providedName | string | Provided name |
-|  suffix | string | Suffix |
+|  providedName | string | <i>(Optional)</i> Provided name |
+|  suffix | string | <i>(Optional)</i> Suffix |
 <b>Returns:</b>

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

@@ -26,7 +26,7 @@ export declare function createInterceptor<CFG, CTX extends Context = InvocationC
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  middlewareFactory | [ExpressMiddlewareFactory](./express.expressmiddlewarefactory.md)<!-- -->&lt;CFG&gt; | Express middleware factory function. A wrapper can be created if the Express middleware module does not conform to the factory pattern and signature. |
-|  middlewareConfig | CFG | Configuration for the Express middleware |
+|  middlewareConfig | CFG | <i>(Optional)</i> Configuration for the Express middleware |
 <b>Returns:</b>