@loopback/docs

--- lang: en title: 'API docs: service-proxy.servicemixin' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/service-proxy permalink: /doc/en/lb4/apidocs.service-proxy.servicemixin.html ---  [Home](./index.md) > [@loopback/service-proxy](./service-proxy.md) > [ServiceMixin](./service-proxy.servicemixin.md) ## ServiceMixin() function A mixin class for Application that creates a .serviceProvider() function to register a service automatically. Also overrides component function to allow it to register repositories automatically. **Signature:** ```typescript export declare function ServiceMixin<T extends MixinTarget<Application>>(superClass: T): { new (...args: any[]): { 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: import("@loopback/core").ApplicationConfig; readonly state: string; controller: <T>(controllerCtor: import("@loopback/core").ControllerClass<T>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T>; server: <T_1 extends import("@loopback/core").Server>(ctor: Constructor<T_1>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_1>; servers: <T_2 extends import("@loopback/core").Server>(ctors: Constructor<T_2>[]) => Binding<any>[]; getServer: <T_3 extends import("@loopback/core").Server>(target: string | Constructor<T_3>) => Promise<T_3>; init: () => Promise<void>; onInit: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>; start: () => Promise<void>; onStart: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>; stop: () => Promise<void>; onStop: (fn: () => import("@loopback/core").ValueOrPromise<void>) => Binding<import("@loopback/core").LifeCycleObserver>; setMetadata: (metadata: import("@loopback/core").ApplicationMetadata) => void; lifeCycleObserver: <T_4 extends import("@loopback/core").LifeCycleObserver>(ctor: Constructor<T_4>, nameOrOptions?: string | BindingFromClassOptions | undefined) => Binding<T_4>; 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: import("@loopback/core").ContextSubscriptionManager; scope: import("@loopback/core").BindingScope; readonly parent: import("@loopback/core").Context | undefined; emitEvent: <T_5 extends import("@loopback/core").ContextEvent>(type: string, event: T_5) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: BindingAddress<ValueType>) => Binding<ValueType>; add: (binding: Binding<unknown>) => Application; configure: <ConfigValueType = any>(key?: BindingAddress | undefined) => Binding<ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType_1>(key: BindingAddress, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => import("@loopback/core").ValueOrPromise<ConfigValueType_1 | undefined>; getConfig: <ConfigValueType_2>(key: BindingAddress, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => Promise<ConfigValueType_2 | undefined>; getConfigSync: <ConfigValueType_3>(key: BindingAddress, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => ConfigValueType_3 | undefined; unbind: (key: BindingAddress) => boolean; subscribe: (observer: import("@loopback/core").ContextEventObserver) => import("@loopback/core").Subscription; unsubscribe: (observer: import("@loopback/core").ContextEventObserver) => boolean; close: () => void; isSubscribed: (observer: import("@loopback/core").ContextObserver) => boolean; createView: <T_6 = 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_6>; contains: (key: BindingAddress) => boolean; isBound: (key: BindingAddress) => boolean; getOwnerContext: (keyOrBinding: BindingAddress | 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?: 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?: 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>; <ValueType_8>(key: BindingAddress<ValueType_8>, options?: { optional?: boolean | undefined; } | undefined): Binding<ValueType_8> | undefined; }; findOrCreateBinding: <T_7>(key: BindingAddress<T_7>, policy?: import("@loopback/core").BindingCreationPolicy | undefined) => Binding<T_7>; 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: import("@loopback/core").ContextEventListener): Application; (event: string | symbol, listener: (...args: any[]) => void): Application; }; once: { (eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): Application; (event: string | symbol, listener: (...args: any[]) => void): Application; }; addListener: (eventName: string | symbol, listener: (...args: any[]) => void) => Application; removeListener: (eventName: string | symbol, listener: (...args: any[]) => void) => Application; off: (eventName: string | symbol, listener: (...args: any[]) => void) => Application; removeAllListeners: (event?: string | symbol | undefined) => Application; setMaxListeners: (n: number) => Application; getMaxListeners: () => number; listeners: (eventName: string | symbol) => Function[]; rawListeners: (eventName: string | symbol) => Function[]; emit: (eventName: string | symbol, ...args: any[]) => boolean; listenerCount: (eventName: string | symbol) => number; prependListener: (eventName: string | symbol, listener: (...args: any[]) => void) => Application; prependOnceListener: (eventName: string | symbol, listener: (...args: any[]) => void) => Application; eventNames: () => (string | symbol)[]; }; } & T; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | superClass | T | Application class | **Returns:** { new (...args: any\[\]): { serviceProvider<S>(provider: [Constructor](./context.constructor.md)<[Provider](./context.provider.md)<S>>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md)): [Binding](./context.binding.md)<S>; component<C extends [Component](./core.component.md) = [Component](./core.component.md)>(componentCtor: [Constructor](./context.constructor.md)<C>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md)): [Binding](./context.binding.md)<C>; mountComponentServices<C\_1 extends [Component](./core.component.md) = [Component](./core.component.md)>(component: [Constructor](./context.constructor.md)<C\_1>, componentBindingKey?: [BindingAddress](./context.bindingaddress.md)<C\_1> \| undefined): void; readonly options: import("@loopback/core").[ApplicationConfig](./core.applicationconfig.md); readonly state: string; controller: <T>(controllerCtor: import("@loopback/core").[ControllerClass](./core.controllerclass.md)<T>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<T>; server: <T\_1 extends import("@loopback/core").[Server](./core.server.md)>(ctor: [Constructor](./context.constructor.md)<T\_1>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<T\_1>; servers: <T\_2 extends import("@loopback/core").[Server](./core.server.md)>(ctors: [Constructor](./context.constructor.md)<T\_2>\[\]) => [Binding](./context.binding.md)<any>\[\]; getServer: <T\_3 extends import("@loopback/core").[Server](./core.server.md)>(target: string \| [Constructor](./context.constructor.md)<T\_3>) => Promise<T\_3>; init: () => Promise<void>; onInit: (fn: () => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<void>) => [Binding](./context.binding.md)<import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)>; start: () => Promise<void>; onStart: (fn: () => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<void>) => [Binding](./context.binding.md)<import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)>; stop: () => Promise<void>; onStop: (fn: () => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<void>) => [Binding](./context.binding.md)<import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)>; setMetadata: (metadata: import("@loopback/core").[ApplicationMetadata](./core.applicationmetadata.md)) => void; lifeCycleObserver: <T\_4 extends import("@loopback/core").[LifeCycleObserver](./core.lifecycleobserver.md)>(ctor: [Constructor](./context.constructor.md)<T\_4>, nameOrOptions?: string \| [BindingFromClassOptions](./context.bindingfromclassoptions.md) \| undefined) => [Binding](./context.binding.md)<T\_4>; service: <S\_1>(cls: import("@loopback/core").[ServiceOrProviderClass](./core.serviceorproviderclass.md)<S\_1>, nameOrOptions?: string \| [ServiceOptions](./core.serviceoptions.md) \| undefined) => [Binding](./context.binding.md)<S\_1>; interceptor: (interceptor: import("@loopback/core").[Interceptor](./context.interceptor.md) \| [Constructor](./context.constructor.md)<[Provider](./context.provider.md)<import("@loopback/core").[Interceptor](./context.interceptor.md)>>, nameOrOptions?: string \| import("@loopback/core").[InterceptorBindingOptions](./context.interceptorbindingoptions.md) \| undefined) => [Binding](./context.binding.md)<import("@loopback/core").[Interceptor](./context.interceptor.md)>; 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: <T\_5 extends import("@loopback/core").[ContextEvent](./context.contextevent.md)>(type: string, event: T\_5) => void; emitError: (err: unknown) => void; bind: <ValueType = any>(key: [BindingAddress](./context.bindingaddress.md)<ValueType>) => [Binding](./context.binding.md)<ValueType>; add: (binding: [Binding](./context.binding.md)<unknown>) => [Application](./core.application.md); configure: <ConfigValueType = any>(key?: [BindingAddress](./context.bindingaddress.md) \| undefined) => [Binding](./context.binding.md)<ConfigValueType>; getConfigAsValueOrPromise: <ConfigValueType\_1>(key: [BindingAddress](./context.bindingaddress.md), propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<ConfigValueType\_1 \| undefined>; getConfig: <ConfigValueType\_2>(key: [BindingAddress](./context.bindingaddress.md), propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => Promise<ConfigValueType\_2 \| undefined>; getConfigSync: <ConfigValueType\_3>(key: [BindingAddress](./context.bindingaddress.md), propertyPath?: string \| undefined, resolutionOptions?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined) => ConfigValueType\_3 \| undefined; unbind: (key: [BindingAddress](./context.bindingaddress.md)) => boolean; subscribe: (observer: import("@loopback/core").[ContextEventObserver](./context.contexteventobserver.md)) => import("@loopback/core").[Subscription](./context.subscription.md); unsubscribe: (observer: import("@loopback/core").[ContextEventObserver](./context.contexteventobserver.md)) => boolean; close: () => void; isSubscribed: (observer: import("@loopback/core").[ContextObserver](./context.contextobserver.md)) => boolean; createView: <T\_6 = unknown>(filter: import("@loopback/core").[BindingFilter](./context.bindingfilter.md), comparator?: import("@loopback/core").[BindingComparator](./context.bindingcomparator.md) \| undefined, options?: Omit<import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md), "session"> \| undefined) => import("@loopback/core").[ContextView](./context.contextview.md)<T\_6>; contains: (key: [BindingAddress](./context.bindingaddress.md)) => boolean; isBound: (key: [BindingAddress](./context.bindingaddress.md)) => boolean; getOwnerContext: (keyOrBinding: [BindingAddress](./context.bindingaddress.md) \| Readonly<[Binding](./context.binding.md)<unknown>>) => 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)) => import("@loopback/core").[Context](./context.context.md) \| undefined; getResolutionContext: (binding: Readonly<[Binding](./context.binding.md)<unknown>>) => import("@loopback/core").[Context](./context.context.md) \| undefined; isVisibleTo: (ctx: import("@loopback/core").[Context](./context.context.md)) => boolean; find: <ValueType\_1 = any>(pattern?: string \| RegExp \| import("@loopback/core").[BindingFilter](./context.bindingfilter.md) \| undefined) => Readonly<[Binding](./context.binding.md)<ValueType\_1>>\[\]; findByTag: <ValueType\_2 = any>(tagFilter: RegExp \| import("@loopback/core").[BindingTag](./context.bindingtag.md)) => Readonly<[Binding](./context.binding.md)<ValueType\_2>>\[\]; get: { <ValueType\_3>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<ValueType\_3>, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): Promise<ValueType\_3>; <ValueType\_4>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<ValueType\_4>, options: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md)): Promise<ValueType\_4 \| undefined>; }; getSync: { <ValueType\_5>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<ValueType\_5>, session?: import("@loopback/core").[ResolutionSession](./context.resolutionsession.md) \| undefined): ValueType\_5; <ValueType\_6>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<ValueType\_6>, options?: import("@loopback/core").[ResolutionOptions](./context.resolutionoptions.md) \| undefined): ValueType\_6 \| undefined; }; getBinding: { <ValueType\_7 = any>(key: [BindingAddress](./context.bindingaddress.md)<ValueType\_7>): [Binding](./context.binding.md)<ValueType\_7>; <ValueType\_8>(key: [BindingAddress](./context.bindingaddress.md)<ValueType\_8>, options?: { optional?: boolean \| undefined; } \| undefined): [Binding](./context.binding.md)<ValueType\_8> \| undefined; }; findOrCreateBinding: <T\_7>(key: [BindingAddress](./context.bindingaddress.md)<T\_7>, policy?: import("@loopback/core").[BindingCreationPolicy](./context.bindingcreationpolicy.md) \| undefined) => [Binding](./context.binding.md)<T\_7>; getValueOrPromise: <ValueType\_9>(keyWithPath: [BindingAddress](./context.bindingaddress.md)<ValueType\_9>, optionsOrSession?: import("@loopback/core").[ResolutionOptionsOrSession](./context.resolutionoptionsorsession.md) \| undefined) => import("@loopback/core").[ValueOrPromise](./context.valueorpromise.md)<ValueType\_9 \| undefined>; toJSON: () => import("@loopback/core").[JSONObject](./context.jsonobject.md); inspect: (options?: import("@loopback/core").[ContextInspectOptions](./context.contextinspectoptions.md) \| undefined) => 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\[\]) => 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\[\]) => void): [Application](./core.application.md); }; addListener: (eventName: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md); removeListener: (eventName: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md); off: (eventName: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md); removeAllListeners: (event?: string \| symbol \| undefined) => [Application](./core.application.md); setMaxListeners: (n: number) => [Application](./core.application.md); getMaxListeners: () => number; listeners: (eventName: string \| symbol) => Function\[\]; rawListeners: (eventName: string \| symbol) => Function\[\]; emit: (eventName: string \| symbol, ...args: any\[\]) => boolean; listenerCount: (eventName: string \| symbol) => number; prependListener: (eventName: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md); prependOnceListener: (eventName: string \| symbol, listener: (...args: any\[\]) => void) => [Application](./core.application.md); eventNames: () => (string \| symbol)\[\]; }; } & T A new class that extends the super class with service proxy related methods ## Example ```ts class MyApplication extends ServiceMixin(Application) {} ``` Please note: the members in the mixin function are documented in a dummy class called <a href="#ServiceMixinDoc">ServiceMixinDoc</a>