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/service-proxy.servicemixin.md CHANGED Viewed

@@ -20,58 +20,58 @@ A mixin class for Application that creates a .serviceProvider() function to regi
 ```typescript
 export declare function ServiceMixin<T extends MixinTarget<Application>>(superClass: T): {
     new (...args: any[]): {
-        serviceProvider<S>(provider: Constructor<Provider<S>>, nameOrOptions?: string | ServiceOptions | undefined): Binding<S>;
-        component<C extends Component = Component>(componentCtor: Constructor<C>, nameOrOptions?: string | BindingFromClassOptions | undefined): Binding<C>;
+        serviceProvider<S>(provider: Constructor<Provider<S>>, nameOrOptions?: string | ServiceOptions): Binding<S>;
+        component<C extends Component = Component>(componentCtor: Constructor<C>, nameOrOptions?: string | BindingFromClassOptions): Binding<C>;
         mountComponentServices<C_1 extends Component = Component>(component: Constructor<C_1>, componentBindingKey?: BindingAddress<C_1> | undefined): void;
-        readonly options: loopbackContext.ApplicationConfig;
+        readonly options: import("@loopback/core").ApplicationConfig;
         readonly state: string;
-        controller: <T_1>(controllerCtor: loopbackContext.ControllerClass<T_1>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_1>;
-        server: <T_2 extends loopbackContext.Server>(ctor: Constructor<T_2>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_2>;
-        servers: <T_3 extends loopbackContext.Server>(ctors: Constructor<T_3>[]) => Binding<any>[];
-        getServer: <T_4 extends loopbackContext.Server>(target: string | Constructor<T_4>) => Promise<T_4>;
+        controller: <T_1>(controllerCtor: import("@loopback/core").ControllerClass<T_1>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_1>;
+        server: <T_2 extends import("@loopback/core").Server>(ctor: Constructor<T_2>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_2>;
+        servers: <T_3 extends import("@loopback/core").Server>(ctors: Constructor<T_3>[]) => Binding<any>[];
+        getServer: <T_4 extends import("@loopback/core").Server>(target: string | Constructor<T_4>) => Promise<T_4>;
         init: () => Promise<void>;
-        onInit: (fn: () => loopbackContext.ValueOrPromise<void>) => Binding<loopbackContext.LifeCycleObserver>;
+        onInit: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
         start: () => Promise<void>;
-        onStart: (fn: () => loopbackContext.ValueOrPromise<void>) => Binding<loopbackContext.LifeCycleObserver>;
+        onStart: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
         stop: () => Promise<void>;
-        onStop: (fn: () => loopbackContext.ValueOrPromise<void>) => Binding<loopbackContext.LifeCycleObserver>;
-        setMetadata: (metadata: loopbackContext.ApplicationMetadata) => void;
-        lifeCycleObserver: <T_5 extends loopbackContext.LifeCycleObserver>(ctor: Constructor<T_5>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_5>;
-        service: <S_1>(cls: loopbackContext.ServiceOrProviderClass<S_1>, nameOrOptions?: string | ServiceOptions | undefined) => Binding<S_1>;
-        interceptor: (interceptor: loopbackContext.Interceptor | Constructor<Provider<loopbackContext.Interceptor>>, nameOrOptions?: string | loopbackContext.InterceptorBindingOptions | undefined) => Binding<loopbackContext.Interceptor>;
+        onStop: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>;
+        setMetadata: (metadata: import("@loopback/core").ApplicationMetadata) => void;
+        lifeCycleObserver: <T_5 extends import("@loopback/core").LifeCycleObserver>(ctor: Constructor<T_5>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_5>;
+        service: <S_1>(cls: import("@loopback/core").ServiceOrProviderClass<S_1>, nameOrOptions?: string | ServiceOptions | undefined) => Binding<S_1>;
+        interceptor: (interceptor: import("@loopback/core").Interceptor | Constructor<Provider<import("@loopback/core").Interceptor>>, nameOrOptions?: string | import("@loopback/core").InterceptorBindingOptions | undefined) => Binding<import("@loopback/core").Interceptor>;
         readonly name: string;
-        readonly subscriptionManager: loopbackContext.ContextSubscriptionManager;
-        scope: loopbackContext.BindingScope;
-        readonly parent: loopbackContext.Context | undefined;
-        emitEvent: <T_6 extends loopbackContext.ContextEvent>(type: string, event: T_6) => void;
+        readonly subscriptionManager: import("@loopback/core").ContextSubscriptionManager;
+        scope: import("@loopback/core").BindingScope;
+        readonly parent: import("@loopback/core").Context | undefined;
+        emitEvent: <T_6 extends import("@loopback/core").ContextEvent>(type: string, event: T_6) => void;
         emitError: (err: unknown) => void;
         bind: <ValueType = any>(key: BindingAddress<ValueType>) => Binding<ValueType>;
         add: (binding: Binding<unknown>) => Application;
         configure: <ConfigValueType = any>(key?: BindingAddress<unknown> | undefined) => Binding<ConfigValueType>;
-        getConfigAsValueOrPromise: <ConfigValueType_1>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: loopbackContext.ResolutionOptions | undefined) => loopbackContext.ValueOrPromise<ConfigValueType_1 | undefined>;
-        getConfig: <ConfigValueType_2>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: loopbackContext.ResolutionOptions | undefined) => Promise<ConfigValueType_2 | undefined>;
-        getConfigSync: <ConfigValueType_3>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: loopbackContext.ResolutionOptions | undefined) => ConfigValueType_3 | undefined;
+        getConfigAsValueOrPromise: <ConfigValueType_1>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => import("@loopback/core").ValueOrPromise<ConfigValueType_1 | undefined>;
+        getConfig: <ConfigValueType_2>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => Promise<ConfigValueType_2 | undefined>;
+        getConfigSync: <ConfigValueType_3>(key: BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => ConfigValueType_3 | undefined;
         unbind: (key: BindingAddress<unknown>) => boolean;
-        subscribe: (observer: loopbackContext.ContextEventObserver) => loopbackContext.Subscription;
-        unsubscribe: (observer: loopbackContext.ContextEventObserver) => boolean;
+        subscribe: (observer: import("@loopback/core").ContextEventObserver) => import("@loopback/core").Subscription;
+        unsubscribe: (observer: import("@loopback/core").ContextEventObserver) => boolean;
         close: () => void;
-        isSubscribed: (observer: loopbackContext.ContextObserver) => boolean;
-        createView: <T_7 = unknown>(filter: loopbackContext.BindingFilter, comparator?: loopbackContext.BindingComparator | undefined, options?: Omit<loopbackContext.ResolutionOptions, "session"> | undefined) => loopbackContext.ContextView<T_7>;
+        isSubscribed: (observer: import("@loopback/core").ContextObserver) => boolean;
+        createView: <T_7 = unknown>(filter: import("@loopback/core").BindingFilter, comparator?: import("@loopback/core").BindingComparator | undefined, options?: Omit<import("@loopback/core").ResolutionOptions, "session"> | undefined) => import("@loopback/core").ContextView<T_7>;
         contains: (key: BindingAddress<unknown>) => boolean;
         isBound: (key: BindingAddress<unknown>) => boolean;
-        getOwnerContext: (keyOrBinding: BindingAddress<unknown> | Readonly<Binding<unknown>>) => loopbackContext.Context | undefined;
-        getScopedContext: (scope: loopbackContext.BindingScope.APPLICATION | loopbackContext.BindingScope.SERVER | loopbackContext.BindingScope.REQUEST) => loopbackContext.Context | undefined;
-        getResolutionContext: (binding: Readonly<Binding<unknown>>) => loopbackContext.Context | undefined;
-        isVisibleTo: (ctx: loopbackContext.Context) => boolean;
-        find: <ValueType_1 = any>(pattern?: string | RegExp | loopbackContext.BindingFilter | undefined) => Readonly<Binding<ValueType_1>>[];
-        findByTag: <ValueType_2 = any>(tagFilter: RegExp | loopbackContext.BindingTag) => Readonly<Binding<ValueType_2>>[];
+        getOwnerContext: (keyOrBinding: BindingAddress<unknown> | Readonly<Binding<unknown>>) => import("@loopback/core").Context | undefined;
+        getScopedContext: (scope: import("@loopback/core").BindingScope.APPLICATION | import("@loopback/core").BindingScope.SERVER | import("@loopback/core").BindingScope.REQUEST) => import("@loopback/core").Context | undefined;
+        getResolutionContext: (binding: Readonly<Binding<unknown>>) => import("@loopback/core").Context | undefined;
+        isVisibleTo: (ctx: import("@loopback/core").Context) => boolean;
+        find: <ValueType_1 = any>(pattern?: string | RegExp | import("@loopback/core").BindingFilter | undefined) => Readonly<Binding<ValueType_1>>[];
+        findByTag: <ValueType_2 = any>(tagFilter: RegExp | import("@loopback/core").BindingTag) => Readonly<Binding<ValueType_2>>[];
         get: {
-            <ValueType_3>(keyWithPath: BindingAddress<ValueType_3>, session?: loopbackContext.ResolutionSession | undefined): Promise<ValueType_3>;
-            <ValueType_4>(keyWithPath: BindingAddress<ValueType_4>, options: loopbackContext.ResolutionOptions): Promise<ValueType_4 | undefined>;
+            <ValueType_3>(keyWithPath: BindingAddress<ValueType_3>, session?: import("@loopback/core").ResolutionSession | undefined): Promise<ValueType_3>;
+            <ValueType_4>(keyWithPath: BindingAddress<ValueType_4>, options: import("@loopback/core").ResolutionOptions): Promise<ValueType_4 | undefined>;
         };
         getSync: {
-            <ValueType_5>(keyWithPath: BindingAddress<ValueType_5>, session?: loopbackContext.ResolutionSession | undefined): ValueType_5;
-            <ValueType_6>(keyWithPath: BindingAddress<ValueType_6>, options?: loopbackContext.ResolutionOptions | undefined): ValueType_6 | undefined;
+            <ValueType_5>(keyWithPath: BindingAddress<ValueType_5>, session?: import("@loopback/core").ResolutionSession | undefined): ValueType_5;
+            <ValueType_6>(keyWithPath: BindingAddress<ValueType_6>, options?: import("@loopback/core").ResolutionOptions | undefined): ValueType_6 | undefined;
         };
         getBinding: {
             <ValueType_7 = any>(key: BindingAddress<ValueType_7>): Binding<ValueType_7>;
@@ -79,16 +79,16 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
                 optional?: boolean | undefined;
             } | undefined): Binding<ValueType_8> | undefined;
         };
-        findOrCreateBinding: <T_8>(key: BindingAddress<T_8>, policy?: loopbackContext.BindingCreationPolicy | undefined) => Binding<T_8>;
-        getValueOrPromise: <ValueType_9>(keyWithPath: BindingAddress<ValueType_9>, optionsOrSession?: loopbackContext.ResolutionOptionsOrSession | undefined) => loopbackContext.ValueOrPromise<ValueType_9 | undefined>;
-        toJSON: () => loopbackContext.JSONObject;
-        inspect: (options?: loopbackContext.ContextInspectOptions | undefined) => loopbackContext.JSONObject;
+        findOrCreateBinding: <T_8>(key: BindingAddress<T_8>, policy?: import("@loopback/core").BindingCreationPolicy | undefined) => Binding<T_8>;
+        getValueOrPromise: <ValueType_9>(keyWithPath: BindingAddress<ValueType_9>, optionsOrSession?: import("@loopback/core").ResolutionOptionsOrSession | undefined) => import("@loopback/core").ValueOrPromise<ValueType_9 | undefined>;
+        toJSON: () => import("@loopback/core").JSONObject;
+        inspect: (options?: import("@loopback/core").ContextInspectOptions | undefined) => import("@loopback/core").JSONObject;
         on: {
-            (eventName: "bind" | "unbind", listener: loopbackContext.ContextEventListener): Application;
+            (eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Application;
             (event: string | symbol, listener: (...args: any[]) => void): Application;
         };
         once: {
-            (eventName: "bind" | "unbind", listener: loopbackContext.ContextEventListener): Application;
+            (eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Application;
             (event: string | symbol, listener: (...args: any[]) => void): Application;
         };
         addListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
@@ -100,7 +100,7 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
         listeners: (event: string | symbol) => Function[];
         rawListeners: (event: string | symbol) => Function[];
         emit: (event: string | symbol, ...args: any[]) => boolean;
-        listenerCount: (type: string | symbol) => number;
+        listenerCount: (event: string | symbol) => number;
         prependListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
         prependOnceListener: (event: string | symbol, listener: (...args: any[]) => void) => Application;
         eventNames: () => (string | symbol)[];
@@ -116,7 +116,7 @@ export declare function ServiceMixin<T extends MixinTarget<Application>>(superCl
 <b>Returns:</b>
-{ new (...args: any\[\]): { serviceProvider&lt;S&gt;(provider: [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;S&gt;&gt;, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined): [Binding](./context.binding.md)<!-- -->&lt;S&gt;; component&lt;C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->&gt;(componentCtor: [Constructor](./context.constructor.md)<!-- -->&lt;C&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined): [Binding](./context.binding.md)<!-- -->&lt;C&gt;; mountComponentServices&lt;C\_1 extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->&gt;(component: [Constructor](./context.constructor.md)<!-- -->&lt;C\_1&gt;, componentBindingKey?: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;C\_1&gt; \| undefined): void; readonly options: loopbackContext.[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: &lt;T\_1&gt;(controllerCtor: loopbackContext.[ControllerClass](./core.controllerclass.md)<!-- -->&lt;T\_1&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_1&gt;; server: &lt;T\_2 extends loopbackContext.[Server](./core.server.md)<!-- -->&gt;(ctor: [Constructor](./context.constructor.md)<!-- -->&lt;T\_2&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_2&gt;; servers: &lt;T\_3 extends loopbackContext.[Server](./core.server.md)<!-- -->&gt;(ctors: [Constructor](./context.constructor.md)<!-- -->&lt;T\_3&gt;\[\]) =&gt; [Binding](./context.binding.md)<!-- -->&lt;any&gt;\[\]; getServer: &lt;T\_4 extends loopbackContext.[Server](./core.server.md)<!-- -->&gt;(target: string \| [Constructor](./context.constructor.md)<!-- -->&lt;T\_4&gt;) =&gt; Promise&lt;T\_4&gt;; init: () =&gt; Promise&lt;void&gt;; onInit: (fn: () =&gt; loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;void&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;; start: () =&gt; Promise&lt;void&gt;; onStart: (fn: () =&gt; loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;void&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;; stop: () =&gt; Promise&lt;void&gt;; onStop: (fn: () =&gt; loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;void&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;; setMetadata: (metadata: loopbackContext.[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) =&gt; void; lifeCycleObserver: &lt;T\_5 extends loopbackContext.[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;(ctor: [Constructor](./context.constructor.md)<!-- -->&lt;T\_5&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_5&gt;; service: &lt;S\_1&gt;(cls: loopbackContext.[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- -->&lt;S\_1&gt;, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;S\_1&gt;; interceptor: (interceptor: loopbackContext.[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->&gt;&gt;, nameOrOptions?: string \| loopbackContext.[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;loopbackContext.[Interceptor](./context.interceptor.md)<!-- -->&gt;; readonly name: string; readonly subscriptionManager: loopbackContext.[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: loopbackContext.[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: loopbackContext.[Context](./context.context.md) \| undefined; emitEvent: &lt;T\_6 extends loopbackContext.[ContextEvent](./context.contextevent.md)<!-- -->&gt;(type: string, event: T\_6) =&gt; void; emitError: (err: unknown) =&gt; void; bind: &lt;ValueType = any&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;; add: (binding: [Binding](./context.binding.md)<!-- -->&lt;unknown&gt;) =&gt; [Application](./core.application.md)<!-- -->; configure: &lt;ConfigValueType = any&gt;(key?: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt; \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;ConfigValueType&gt;; getConfigAsValueOrPromise: &lt;ConfigValueType\_1&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) =&gt; loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;ConfigValueType\_1 \| undefined&gt;; getConfig: &lt;ConfigValueType\_2&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) =&gt; Promise&lt;ConfigValueType\_2 \| undefined&gt;; getConfigSync: &lt;ConfigValueType\_3&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;, propertyPath?: string \| undefined, resolutionOptions?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined) =&gt; ConfigValueType\_3 \| undefined; unbind: (key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;) =&gt; boolean; subscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) =&gt; loopbackContext.[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: loopbackContext.[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) =&gt; boolean; close: () =&gt; void; isSubscribed: (observer: loopbackContext.[ContextObserver](./context.contextobserver.md)<!-- -->) =&gt; boolean; createView: &lt;T\_7 = unknown&gt;(filter: loopbackContext.[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: loopbackContext.[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit&lt;loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"&gt; \| undefined) =&gt; loopbackContext.[ContextView](./context.contextview.md)<!-- -->&lt;T\_7&gt;; contains: (key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;) =&gt; boolean; isBound: (key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;) =&gt; boolean; getOwnerContext: (keyOrBinding: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt; \| Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;unknown&gt;&gt;) =&gt; loopbackContext.[Context](./context.context.md) \| undefined; getScopedContext: (scope: loopbackContext.[BindingScope.APPLICATION](./context.bindingscope.md) \| loopbackContext.[BindingScope.SERVER](./context.bindingscope.md) \| loopbackContext.[BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) =&gt; loopbackContext.[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;unknown&gt;&gt;) =&gt; loopbackContext.[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: loopbackContext.[Context](./context.context.md)<!-- -->) =&gt; boolean; find: &lt;ValueType\_1 = any&gt;(pattern?: string \| RegExp \| loopbackContext.[BindingFilter](./context.bindingfilter.md) \| undefined) =&gt; Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType\_1&gt;&gt;\[\]; findByTag: &lt;ValueType\_2 = any&gt;(tagFilter: RegExp \| loopbackContext.[BindingTag](./context.bindingtag.md)<!-- -->) =&gt; Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType\_2&gt;&gt;\[\]; get: { &lt;ValueType\_3&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_3&gt;, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise&lt;ValueType\_3&gt;; &lt;ValueType\_4&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_4&gt;, options: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise&lt;ValueType\_4 \| undefined&gt;; }; getSync: { &lt;ValueType\_5&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_5&gt;, session?: loopbackContext.[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; &lt;ValueType\_6&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_6&gt;, options?: loopbackContext.[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { &lt;ValueType\_7 = any&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_7&gt;): [Binding](./context.binding.md)<!-- -->&lt;ValueType\_7&gt;; &lt;ValueType\_8&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_8&gt;, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- -->&lt;ValueType\_8&gt; \| undefined; }; findOrCreateBinding: &lt;T\_8&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;T\_8&gt;, policy?: loopbackContext.[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_8&gt;; getValueOrPromise: &lt;ValueType\_9&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_9&gt;, optionsOrSession?: loopbackContext.[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) =&gt; loopbackContext.[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;ValueType\_9 \| undefined&gt;; toJSON: () =&gt; loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: loopbackContext.[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) =&gt; loopbackContext.[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) =&gt; void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: loopbackContext.[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) =&gt; void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) =&gt; [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) =&gt; [Application](./core.application.md)<!-- -->; getMaxListeners: () =&gt; number; listeners: (event: string \| symbol) =&gt; Function\[\]; rawListeners: (event: string \| symbol) =&gt; Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) =&gt; boolean; listenerCount: (type: string \| symbol) =&gt; number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; eventNames: () =&gt; (string \| symbol)\[\]; }; } &amp; T
+{ new (...args: any\[\]): { serviceProvider&lt;S&gt;(provider: [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;S&gt;&gt;, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- -->&lt;S&gt;; component&lt;C extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->&gt;(componentCtor: [Constructor](./context.constructor.md)<!-- -->&lt;C&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md)<!-- -->): [Binding](./context.binding.md)<!-- -->&lt;C&gt;; mountComponentServices&lt;C\_1 extends [Component](./core.component.md) = [Component](./core.component.md)<!-- -->&gt;(component: [Constructor](./context.constructor.md)<!-- -->&lt;C\_1&gt;, componentBindingKey?: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;C\_1&gt; \| undefined): void; readonly options: import("@loopback/core").[ApplicationConfig](./core.applicationconfig.md)<!-- -->; readonly state: string; controller: &lt;T\_1&gt;(controllerCtor: import("@loopback/core").[ControllerClass](./core.controllerclass.md)<!-- -->&lt;T\_1&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_1&gt;; server: &lt;T\_2 extends import("@loopback/core").[Server](./core.server.md)<!-- -->&gt;(ctor: [Constructor](./context.constructor.md)<!-- -->&lt;T\_2&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_2&gt;; servers: &lt;T\_3 extends import("@loopback/core").[Server](./core.server.md)<!-- -->&gt;(ctors: [Constructor](./context.constructor.md)<!-- -->&lt;T\_3&gt;\[\]) =&gt; [Binding](./context.binding.md)<!-- -->&lt;any&gt;\[\]; getServer: &lt;T\_4 extends import("@loopback/core").[Server](./core.server.md)<!-- -->&gt;(target: string \| [Constructor](./context.constructor.md)<!-- -->&lt;T\_4&gt;) =&gt; Promise&lt;T\_4&gt;; init: () =&gt; Promise&lt;void&gt;; onInit: (fn: () =&gt; import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;void&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;; start: () =&gt; Promise&lt;void&gt;; onStart: (fn: () =&gt; import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;void&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;; stop: () =&gt; Promise&lt;void&gt;; onStop: (fn: () =&gt; import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;void&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;; setMetadata: (metadata: import("@loopback/core").[ApplicationMetadata](./core.applicationmetadata.md)<!-- -->) =&gt; void; lifeCycleObserver: &lt;T\_5 extends import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)<!-- -->&gt;(ctor: [Constructor](./context.constructor.md)<!-- -->&lt;T\_5&gt;, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_5&gt;; service: &lt;S\_1&gt;(cls: import("@loopback/core").[ServiceOrProviderClass](./core.serviceorproviderclass.md)<!-- -->&lt;S\_1&gt;, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;S\_1&gt;; interceptor: (interceptor: import("@loopback/core").[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<!-- -->&lt;[Provider](./context.provider.md)<!-- -->&lt;import("@loopback/core").[Interceptor](./context.interceptor.md)<!-- -->&gt;&gt;, nameOrOptions?: string \| import("@loopback/core").[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;import("@loopback/core").[Interceptor](./context.interceptor.md)<!-- -->&gt;; readonly name: string; readonly subscriptionManager: import("@loopback/core").[ContextSubscriptionManager](./context.contextsubscriptionmanager.md)<!-- -->; scope: import("@loopback/core").[BindingScope](./context.bindingscope.md)<!-- -->; readonly parent: import("@loopback/core").[Context](./context.context.md) \| undefined; emitEvent: &lt;T\_6 extends import("@loopback/core").[ContextEvent](./context.contextevent.md)<!-- -->&gt;(type: string, event: T\_6) =&gt; void; emitError: (err: unknown) =&gt; void; bind: &lt;ValueType = any&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType&gt;) =&gt; [Binding](./context.binding.md)<!-- -->&lt;ValueType&gt;; add: (binding: [Binding](./context.binding.md)<!-- -->&lt;unknown&gt;) =&gt; [Application](./core.application.md)<!-- -->; configure: &lt;ConfigValueType = any&gt;(key?: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt; \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;ConfigValueType&gt;; getConfigAsValueOrPromise: &lt;ConfigValueType\_1&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;, propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) =&gt; import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;ConfigValueType\_1 \| undefined&gt;; getConfig: &lt;ConfigValueType\_2&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;, propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) =&gt; Promise&lt;ConfigValueType\_2 \| undefined&gt;; getConfigSync: &lt;ConfigValueType\_3&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;, propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) =&gt; ConfigValueType\_3 \| undefined; unbind: (key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;) =&gt; boolean; subscribe: (observer: import("@loopback/core").[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) =&gt; import("@loopback/core").[Subscription](./context.subscription.md)<!-- -->; unsubscribe: (observer: import("@loopback/core").[ContextEventObserver](./context.contexteventobserver.md)<!-- -->) =&gt; boolean; close: () =&gt; void; isSubscribed: (observer: import("@loopback/core").[ContextObserver](./context.contextobserver.md)<!-- -->) =&gt; boolean; createView: &lt;T\_7 = unknown&gt;(filter: import("@loopback/core").[BindingFilter](./context.bindingfilter.md)<!-- -->, comparator?: import("@loopback/core").[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit&lt;import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md)<!-- -->, "session"&gt; \| undefined) =&gt; import("@loopback/core").[ContextView](./context.contextview.md)<!-- -->&lt;T\_7&gt;; contains: (key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;) =&gt; boolean; isBound: (key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt;) =&gt; boolean; getOwnerContext: (keyOrBinding: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;unknown&gt; \| Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;unknown&gt;&gt;) =&gt; import("@loopback/core").[Context](./context.context.md) \| undefined; getScopedContext: (scope: import("@loopback/core").[BindingScope.APPLICATION](./context.bindingscope.md) \| import("@loopback/core").[BindingScope.SERVER](./context.bindingscope.md) \| import("@loopback/core").[BindingScope.REQUEST](./context.bindingscope.md)<!-- -->) =&gt; import("@loopback/core").[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;unknown&gt;&gt;) =&gt; import("@loopback/core").[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: import("@loopback/core").[Context](./context.context.md)<!-- -->) =&gt; boolean; find: &lt;ValueType\_1 = any&gt;(pattern?: string \| RegExp \| import("@loopback/core").[BindingFilter](./context.bindingfilter.md) \| undefined) =&gt; Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType\_1&gt;&gt;\[\]; findByTag: &lt;ValueType\_2 = any&gt;(tagFilter: RegExp \| import("@loopback/core").[BindingTag](./context.bindingtag.md)<!-- -->) =&gt; Readonly&lt;[Binding](./context.binding.md)<!-- -->&lt;ValueType\_2&gt;&gt;\[\]; get: { &lt;ValueType\_3&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_3&gt;, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise&lt;ValueType\_3&gt;; &lt;ValueType\_4&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_4&gt;, options: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md)<!-- -->): Promise&lt;ValueType\_4 \| undefined&gt;; }; getSync: { &lt;ValueType\_5&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_5&gt;, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; &lt;ValueType\_6&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_6&gt;, options?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { &lt;ValueType\_7 = any&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_7&gt;): [Binding](./context.binding.md)<!-- -->&lt;ValueType\_7&gt;; &lt;ValueType\_8&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_8&gt;, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<!-- -->&lt;ValueType\_8&gt; \| undefined; }; findOrCreateBinding: &lt;T\_8&gt;(key: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;T\_8&gt;, policy?: import("@loopback/core").[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) =&gt; [Binding](./context.binding.md)<!-- -->&lt;T\_8&gt;; getValueOrPromise: &lt;ValueType\_9&gt;(keyWithPath: [BindingAddress](./context.bindingaddress.md)<!-- -->&lt;ValueType\_9&gt;, optionsOrSession?: import("@loopback/core").[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) =&gt; import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<!-- -->&lt;ValueType\_9 \| undefined&gt;; toJSON: () =&gt; import("@loopback/core").[JSONObject](./context.jsonobject.md)<!-- -->; inspect: (options?: import("@loopback/core").[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) =&gt; import("@loopback/core").[JSONObject](./context.jsonobject.md)<!-- -->; on: { (eventName: "bind" \| "unbind", listener: import("@loopback/core").[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) =&gt; void): [Application](./core.application.md)<!-- -->; }; once: { (eventName: "bind" \| "unbind", listener: import("@loopback/core").[ContextEventListener](./context.contexteventlistener.md)<!-- -->): [Application](./core.application.md)<!-- -->; (event: string \| symbol, listener: (...args: any\[\]) =&gt; void): [Application](./core.application.md)<!-- -->; }; addListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; removeListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; off: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; removeAllListeners: (event?: string \| symbol \| undefined) =&gt; [Application](./core.application.md)<!-- -->; setMaxListeners: (n: number) =&gt; [Application](./core.application.md)<!-- -->; getMaxListeners: () =&gt; number; listeners: (event: string \| symbol) =&gt; Function\[\]; rawListeners: (event: string \| symbol) =&gt; Function\[\]; emit: (event: string \| symbol, ...args: any\[\]) =&gt; boolean; listenerCount: (event: string \| symbol) =&gt; number; prependListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; prependOnceListener: (event: string \| symbol, listener: (...args: any\[\]) =&gt; void) =&gt; [Application](./core.application.md)<!-- -->; eventNames: () =&gt; (string \| symbol)\[\]; }; } &amp; T
 A new class that extends the super class with service proxy related methods

package/site/apidocs/service-proxy.serviceproxy.md CHANGED Viewed

@@ -16,7 +16,7 @@ permalink: /doc/en/lb4/apidocs.service-proxy.serviceproxy.html
 <b>Signature:</b>
 ```typescript
-export declare function serviceProxy(dataSource: string | juggler.DataSource): (target: object, key: string, parameterIndex?: number | undefined) => void;
+export declare function serviceProxy(dataSource: string | juggler.DataSource): (target: object, key: string, parameterIndex?: number) => void;
 ```
 ## Parameters
@@ -27,6 +27,6 @@ export declare function serviceProxy(dataSource: string | juggler.DataSource): (
 <b>Returns:</b>
-(target: object, key: string, parameterIndex?: number \| undefined) =&gt; void
+(target: object, key: string, parameterIndex?: number) =&gt; void

package/site/apidocs/socketio.socketioapplication._constructor_.md CHANGED Viewed

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

package/site/apidocs/socketio.socketioapplication.server.md CHANGED Viewed

@@ -24,7 +24,7 @@ server(server: Constructor<Server>, name?: string): Binding;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  server | [Constructor](./context.constructor.md)<!-- -->&lt;[Server](./core.server.md)<!-- -->&gt; |  |
-|  name | string |  |
+|  name | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/socketio.socketioinvokemethodprovider.md CHANGED Viewed

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

package/site/apidocs/socketio.socketiorejectprovider.md CHANGED Viewed

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiorejectprovider.html
 ```typescript
 export declare class SocketIoRejectProvider implements Provider<SocketIoRejectMethod>
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoRejectMethod](./socketio.socketiorejectmethod.md)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoRejectMethod](./socketio.socketiorejectmethod.md)
 ## Methods

package/site/apidocs/socketio.socketiosendprovider.md CHANGED Viewed

@@ -18,7 +18,7 @@ permalink: /doc/en/lb4/apidocs.socketio.socketiosendprovider.html
 ```typescript
 export declare class SocketIoSendProvider implements Provider<SocketIoSendMethod>
 ```
-<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoSendMethod](./socketio.socketiosendmethod.md)<!-- -->&gt;
+<b>Implements:</b> [Provider](./context.provider.md)<!-- -->&lt;[SocketIoSendMethod](./socketio.socketiosendmethod.md)
 ## Methods

package/site/apidocs/socketio.socketioserver._constructor_.md CHANGED Viewed

@@ -26,6 +26,6 @@ constructor(app: Application, options?: SocketIoServerOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  app | [Application](./core.application.md) |  |
-|  options | [SocketIoServerOptions](./socketio.socketioserveroptions.md) |  |
+|  options | [SocketIoServerOptions](./socketio.socketioserveroptions.md) | <i>(Optional)</i> |

package/site/apidocs/socketio.socketioserver.route.md CHANGED Viewed

@@ -26,7 +26,7 @@ route(controllerClass: Constructor<object>, meta?: SocketIoMetadata | string | R
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  controllerClass | [Constructor](./context.constructor.md)<!-- -->&lt;object&gt; |  |
-|  meta | [SocketIoMetadata](./socketio.socketiometadata.md) \| string \| RegExp |  |
+|  meta | [SocketIoMetadata](./socketio.socketiometadata.md) \| string \| RegExp | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/testlab.createunexpectedhttperrorlogger.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function createUnexpectedHttpErrorLogger(expectedStatusCode?: num
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  expectedStatusCode | number | HTTP status code that is expected |
+|  expectedStatusCode | number | <i>(Optional)</i> HTTP status code that is expected |
 <b>Returns:</b>

package/site/apidocs/testlab.givenhttpserverconfig.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function givenHttpServerConfig<T extends HttpOptions | HttpsOptio
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  customConfig | T | Additional configuration options to apply. |
+|  customConfig | T | <i>(Optional)</i> Additional configuration options to apply. |
 <b>Returns:</b>

package/site/apidocs/testlab.httpgetasync.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function httpGetAsync(urlString: string, agent?: http.Agent): Pro
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  urlString | string |  |
-|  agent | http.Agent |  |
+|  agent | http.Agent | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/testlab.httpsgetasync.md CHANGED Viewed

@@ -26,7 +26,7 @@ export declare function httpsGetAsync(urlString: string, agent?: https.Agent): P
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  urlString | string |  |
-|  agent | https.Agent |  |
+|  agent | https.Agent | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/testlab.stubexpresscontext.md CHANGED Viewed

@@ -23,7 +23,7 @@ export declare function stubExpressContext(requestOptions?: ShotRequestOptions):
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  requestOptions | ShotRequestOptions |  |
+|  requestOptions | ShotRequestOptions | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/testlab.stubhandlercontext.md CHANGED Viewed

@@ -23,7 +23,7 @@ export declare function stubHandlerContext(requestOptions?: ShotRequestOptions):
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  requestOptions | ShotRequestOptions |  |
+|  requestOptions | ShotRequestOptions | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/testlab.testsandbox._constructor_.md CHANGED Viewed

@@ -26,7 +26,7 @@ constructor(rootPath: string, options?: TestSandboxOptions);
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  rootPath | string | Root path of the TestSandbox. If relative it will be resolved against the current directory. |
-|  options | [TestSandboxOptions](./testlab.testsandboxoptions.md) | Options to control if/how the sandbox creates a subdirectory for the sandbox. If not provided, the sandbox will automatically creates a unique temporary subdirectory. This allows sandboxes with the same root path can be used in parallel during testing. |
+|  options | [TestSandboxOptions](./testlab.testsandboxoptions.md) | <i>(Optional)</i> Options to control if/how the sandbox creates a subdirectory for the sandbox. If not provided, the sandbox will automatically creates a unique temporary subdirectory. This allows sandboxes with the same root path can be used in parallel during testing. |
 ## Example

package/site/apidocs/testlab.testsandbox.copyfile.md CHANGED Viewed

@@ -26,8 +26,8 @@ copyFile(src: string, dest?: string, transform?: (content: string) => string): P
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  src | string | Absolute path of file to be copied to the TestSandbox |
-|  dest | string | Optional. Destination filename of the copy operation (relative to TestSandbox). Original filename used if not specified. |
-|  transform | (content: string) =&gt; string | Optional. A function to transform the file content. |
+|  dest | string | <i>(Optional)</i> Optional. Destination filename of the copy operation (relative to TestSandbox). Original filename used if not specified. |
+|  transform | (content: string) =&gt; string | <i>(Optional)</i> Optional. A function to transform the file content. |
 <b>Returns:</b>

package/site/apidocs/tsdocs.getpackages.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function getPackages(rootDir?: string): Promise<LernaPackage[]>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  rootDir | string | Root directory to find lerna.json |
+|  rootDir | string | <i>(Optional)</i> Root directory to find lerna.json |
 <b>Returns:</b>

package/site/apidocs/tsdocs.getpackageswithtsdocs.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function getPackagesWithTsDocs(rootDir?: string): Promise<LernaPa
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  rootDir | string | Root directory to find the monorepo |
+|  rootDir | string | <i>(Optional)</i> Root directory to find the monorepo |
 <b>Returns:</b>

package/site/apidocs/tsdocs.runextractorformonorepo.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function runExtractorForMonorepo(options?: ExtractorOptions): Pro
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [ExtractorOptions](./tsdocs.extractoroptions.md) | Options for running api-extractor |
+|  options | [ExtractorOptions](./tsdocs.extractoroptions.md) | <i>(Optional)</i> Options for running api-extractor |
 <b>Returns:</b>

package/site/apidocs/tsdocs.runextractorforpackage.md CHANGED Viewed

@@ -23,8 +23,8 @@ export declare function runExtractorForPackage(pkgDir?: string, options?: Extrac
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  pkgDir | string |  |
-|  options | [ExtractorOptions](./tsdocs.extractoroptions.md) |  |
+|  pkgDir | string | <i>(Optional)</i> |
+|  options | [ExtractorOptions](./tsdocs.extractoroptions.md) | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/tsdocs.updateapidocs.md CHANGED Viewed

@@ -25,7 +25,7 @@ export declare function updateApiDocs(options?: ApiDocsOptions): Promise<void>;
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  options | [ApiDocsOptions](./tsdocs.apidocsoptions.md) | Options for api docs |
+|  options | [ApiDocsOptions](./tsdocs.apidocsoptions.md) | <i>(Optional)</i> Options for api docs |
 <b>Returns:</b>

package/site/apidocs/typeorm.getmodelschema.md CHANGED Viewed

@@ -28,7 +28,7 @@ export declare function getModelSchema<T extends object>(modelCtor: Function & {
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  modelCtor | Function &amp; { prototype: T; } | The entity constructor (e.g. <code>Product</code>) |
-|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | Additional options |
+|  options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | <i>(Optional)</i> Additional options |
 <b>Returns:</b>

package/site/apidocs/typeorm.typeorm.repository.md CHANGED Viewed

@@ -24,7 +24,7 @@ function repository(entity: Function, connectionName?: string): (target: Object,
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  entity | Function |  |
-|  connectionName | string |  |
+|  connectionName | string | <i>(Optional)</i> |
 <b>Returns:</b>

package/site/apidocs/typeorm.typeormcomponent._constructor_.md CHANGED Viewed

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

package/site/apidocs/typeorm.typeormconnectionbooter._constructor_.md CHANGED Viewed

@@ -27,6 +27,6 @@ constructor(app: ApplicationUsingTypeOrm, projectRoot: string, entityConfig?: Ar
 |  --- | --- | --- |
 |  app | [ApplicationUsingTypeOrm](./typeorm.applicationusingtypeorm.md) |  |
 |  projectRoot | string |  |
-|  entityConfig | [ArtifactOptions](./boot.artifactoptions.md) |  |
+|  entityConfig | [ArtifactOptions](./boot.artifactoptions.md) | <i>(Optional)</i> |