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

@loopback/docs 4.0.4 → 5.1.1

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 (691) hide show

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

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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>

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

@@ -25,7 +25,7 @@ find<ValueType = BoundValue>(pattern?: string | RegExp | BindingFilter): Readonl
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  pattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | A filter function, a regexp or a wildcard pattern with optional <code>*</code> and <code>?</code>. Find returns such bindings where the key matches the provided pattern.<!-- -->For a wildcard: - <code>*</code> matches zero or more characters except <code>.</code> and <code>:</code> - <code>?</code> matches exactly one character except <code>.</code> and <code>:</code>For a filter function: - return <code>true</code> to include the binding in the results - return <code>false</code> to exclude it. |
+|  pattern | string \| RegExp \| [BindingFilter](./context.bindingfilter.md) | <i>(Optional)</i> A filter function, a regexp or a wildcard pattern with optional <code>*</code> and <code>?</code>. Find returns such bindings where the key matches the provided pattern.<!-- -->For a wildcard: - <code>*</code> matches zero or more characters except <code>.</code> and <code>:</code> - <code>?</code> matches exactly one character except <code>.</code> and <code>:</code>For a filter function: - return <code>true</code> to include the binding in the results - return <code>false</code> to exclude it. |
 <b>Returns:</b>

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

@@ -26,7 +26,7 @@ findOrCreateBinding<T>(key: BindingAddress<T>, policy?: BindingCreationPolicy):
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;T&gt; | Binding address |
-|  policy | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | Binding creation policy |
+|  policy | [BindingCreationPolicy](./context.bindingcreationpolicy.md) | <i>(Optional)</i> Binding creation policy |
 <b>Returns:</b>

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

@@ -26,7 +26,7 @@ get<ValueType>(keyWithPath: BindingAddress<ValueType>, session?: ResolutionSessi
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  keyWithPath | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
-|  session | [ResolutionSession](./context.resolutionsession.md) | Optional session for resolution (accepted for backward compatibility) |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Optional session for resolution (accepted for backward compatibility) |
 <b>Returns:</b>

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

@@ -28,7 +28,7 @@ getBinding<ValueType>(key: BindingAddress<ValueType>, options?: {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | Binding key |
-|  options | { optional?: boolean; } | Options to control if the binding is optional. If <code>options.optional</code> is set to true, the method will return <code>undefined</code> instead of throwing an error if the binding key is not found. |
+|  options | { optional?: boolean; } | <i>(Optional)</i> Options to control if the binding is optional. If <code>options.optional</code> is set to true, the method will return <code>undefined</code> instead of throwing an error if the binding key is not found. |
 <b>Returns:</b>

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

@@ -26,8 +26,8 @@ getConfig<ConfigValueType>(key: BindingAddress, propertyPath?: string, resolutio
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md) | 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>&lt;config&gt;</code> object will be returned. |
-|  resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | Options for the resolution. |
+|  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>&lt;config&gt;</code> object will be returned. |
+|  resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for the resolution. |
 <b>Returns:</b>

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

@@ -26,8 +26,8 @@ getConfigAsValueOrPromise<ConfigValueType>(key: BindingAddress, propertyPath?: s
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md) | 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>&lt;config&gt;</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>&lt;config&gt;</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.getconfigsync.md CHANGED Viewed

@@ -26,8 +26,8 @@ getConfigSync<ConfigValueType>(key: BindingAddress, propertyPath?: string, resol
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  key | [BindingAddress](./context.bindingaddress.md) | Binding key |
-|  propertyPath | string | Property path for the option. For example, <code>x.y</code> requests for <code>config.x.y</code>. If not set, the <code>config</code> object will be returned. |
-|  resolutionOptions | [ResolutionOptions](./context.resolutionoptions.md) | Options for the resolution. |
+|  propertyPath | string | <i>(Optional)</i> Property path for the option. For example, <code>x.y</code> requests for <code>config.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. |
 <b>Returns:</b>

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

@@ -28,7 +28,7 @@ getSync<ValueType>(keyWithPath: BindingAddress<ValueType>, session?: ResolutionS
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  keyWithPath | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
-|  session | [ResolutionSession](./context.resolutionsession.md) | Session for resolution (accepted for backward compatibility) |
+|  session | [ResolutionSession](./context.resolutionsession.md) | <i>(Optional)</i> Session for resolution (accepted for backward compatibility) |
 <b>Returns:</b>

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

@@ -28,7 +28,7 @@ getSync<ValueType>(keyWithPath: BindingAddress<ValueType>, options?: ResolutionO
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  keyWithPath | [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt; | The binding key, optionally suffixed with a path to the (deeply) nested property to retrieve. |
-|  options | [ResolutionOptions](./context.resolutionoptions.md) | Options for resolution. |
+|  options | [ResolutionOptions](./context.resolutionoptions.md) | <i>(Optional)</i> Options for resolution. |
 <b>Returns:</b>

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

@@ -25,7 +25,7 @@ inspect(options?: ContextInspectOptions): JSONObject;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [ContextInspectOptions](./context.contextinspectoptions.md) | Options for inspect |
+|  options | [ContextInspectOptions](./context.contextinspectoptions.md) | <i>(Optional)</i> Options for inspect |
 <b>Returns:</b>

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.inject.binding.md CHANGED Viewed

@@ -18,7 +18,7 @@ Inject the binding object for the given key. This is useful if a binding needs t
 <b>Signature:</b>
 ```typescript
-binding: (bindingKey?: string | BindingKey<unknown> | undefined, metadata?: InjectBindingMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
+binding: (bindingKey?: string | BindingKey<unknown>, metadata?: InjectBindingMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
 ```
 ## Example

package/site/apidocs/context.inject.getter.md CHANGED Viewed

@@ -22,6 +22,6 @@ See also `Getter<T>`<!-- -->.
 <b>Signature:</b>
 ```typescript
-getter: (bindingSelector: BindingSelector<unknown>, metadata?: InjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
+getter: (bindingSelector: BindingSelector<unknown>, metadata?: InjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
 ```

package/site/apidocs/context.inject.setter.md CHANGED Viewed

@@ -22,6 +22,6 @@ See also `Setter<T>`<!-- -->.
 <b>Signature:</b>
 ```typescript
-setter: (bindingKey: BindingAddress, metadata?: InjectBindingMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
+setter: (bindingKey: BindingAddress, metadata?: InjectBindingMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
 ```

package/site/apidocs/context.inject.tag.md CHANGED Viewed

@@ -18,7 +18,7 @@ Inject an array of values by a tag pattern string or regexp
 <b>Signature:</b>
 ```typescript
-tag: (bindingTag: BindingTag | RegExp, metadata?: InjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
+tag: (bindingTag: BindingTag | RegExp, metadata?: InjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
 ```
 ## Example

package/site/apidocs/context.inject.view.md CHANGED Viewed

@@ -18,7 +18,7 @@ Inject matching bound values by the filter function
 <b>Signature:</b>
 ```typescript
-view: (bindingFilter: BindingFilter, metadata?: InjectionMetadata | undefined) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
+view: (bindingFilter: BindingFilter, metadata?: InjectionMetadata) => (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void
 ```
 ## Example

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.intercept.md CHANGED Viewed

@@ -18,7 +18,7 @@ Decorator function `@intercept` for classes/methods to apply interceptors. It ca
 <b>Signature:</b>
 ```typescript
-export declare function intercept(...interceptorOrKeys: InterceptorOrKey[]): (target: any, method?: string | undefined, methodDescriptor?: TypedPropertyDescriptor<any> | undefined) => any;
+export declare function intercept(...interceptorOrKeys: InterceptorOrKey[]): (target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor<any>) => any;
 ```
 ## Parameters
@@ -29,7 +29,7 @@ export declare function intercept(...interceptorOrKeys: InterceptorOrKey[]): (ta
 <b>Returns:</b>
-(target: any, method?: string \| undefined, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt; \| undefined) =&gt; any
+(target: any, method?: string, methodDescriptor?: TypedPropertyDescriptor&lt;any&gt;) =&gt; any
 ## Example

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>