Skip to main content

Service

@webda/core

Abstract Class: Service<T, E>

Defined in: packages/core/src/services/service.ts:154

Use this object for representing a service in the application A Service is a singleton in the application, that is init after all others services are created

You can use a Service to create Listeners or implement shared behavior between others services

Exports​

Service

Extends​

Extended by​

Type Parameters​

T​

T extends ServiceParameters = ServiceParameters

E​

E extends AsyncEventUnknown = { }

Constructors​

Constructor​

new Service<T, E>(name, params): Service<T, E>

Defined in: packages/core/src/services/service.ts:192

Service

Parameters​

name​

string

The name of the service

params​

T

The parameters block define in the configuration file

Returns​

Service<T, E>

Overrides​

AbstractService.constructor

Properties​

_compiledCapabilities​

protected _compiledCapabilities: Record<string, any> = {}

Defined in: packages/core/src/services/iservice.ts:58

Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.

Populated during Service.resolve by reading the service's entry in webda.module.json. Each key is a capability name (e.g., "request-filter"), and the value is an empty object {} by default. Override getCapabilities to provide capability-specific configuration or to conditionally disable capabilities.

See​

getCapabilities

Inherited from​

AbstractService._compiledCapabilities

[WEBDA_EVENTS]​

[WEBDA_EVENTS]: E

Defined in: packages/core/src/services/service.ts:166

Set the Webda events here

logger​

protected logger: Logger

Defined in: packages/core/src/services/service.ts:179

Logger with class context

metrics?​

protected optional metrics?: object

Defined in: packages/core/src/services/service.ts:183

Get metrics

name​

readonly name: string

Defined in: packages/core/src/services/iservice.ts:35

Inherited from​

AbstractService.name

parameters​

readonly parameters: T

Defined in: packages/core/src/services/iservice.ts:36

Inherited from​

AbstractService.parameters

createConfiguration?​

static optional createConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:41

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

AbstractService.createConfiguration

filterConfiguration?​

static optional filterConfiguration?: (params) => any

Defined in: packages/core/src/services/iservice.ts:46

Create configuration set by the application on load

Parameters​

params​

any

Returns​

any

Inherited from​

AbstractService.filterConfiguration

Parameters​

static Parameters: typeof ServiceParameters = ServiceParameters

Defined in: packages/core/src/services/service.ts:162

Service parameters

Methods​

__clean()​

abstract __clean(): Promise<void>

Defined in: packages/core/src/services/service.ts:492

Clean the service data, can only be used in test mode

Returns​

Promise<void>

addListener()​

addListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:83

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void | Promise<void>

the event listener

Returns​

this

this for chaining

See​

EventEmitter.addListener

Inherited from​

AbstractService.addListener

addRoute()​

protected addRoute(url, methods, executer, openapi?, override?): void

Defined in: packages/core/src/services/service.ts:384

Add a route dynamicaly

Parameters​

url​

string

of the route can contains dynamic part like {uuid}

methods​

HttpMethodType[]

the HTTP methods

executer​

Function

Method to execute for this route

openapi?​

OpenAPIWebdaDefinition = {}

the OpenAPI specification

override?​

boolean = false

whether to override existing

Returns​

void

authorizeClientEvent()​

authorizeClientEvent(_event, _context): boolean

Defined in: packages/core/src/services/service.ts:337

Authorize a public event subscription

Parameters​

_event​

string

the event name

_context​

OperationContext

the execution context

Returns​

boolean

true if the condition is met

computeParameters()​

computeParameters(): void

Defined in: packages/core/src/services/service.ts:201

Used to compute or derivate input parameter to attribute

Returns​

void

Deprecated​

emit()​

emit<Key>(event, data): Promise<void>

Defined in: packages/core/src/services/service.ts:473

Emit the event with data and wait for Promise to finish if listener returned a Promise

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

event​

Key

the event name

data​

E[Key]

the data to process

Returns​

Promise<void>

Overrides​

AbstractService.emit

getCapabilities()​

getCapabilities(): Record<string, any>

Defined in: packages/core/src/services/iservice.ts:86

Return the capabilities of this service.

By default returns capabilities detected at compile-time from

Returns​

Record<string, any>

the result

Webda Capability-tagged​

interfaces in webda.module.json.

Override to disable capabilities based on configuration:

getCapabilities() {
  const caps = super.getCapabilities();
  if (!this.parameters.enabled) delete caps["request-filter"];
  return caps;
}

Inherited from​

AbstractService.getCapabilities

getClientEvents()​

getClientEvents(): string[]

Defined in: packages/core/src/services/service.ts:325

Return the events that an external system can subscribe to

Returns​

string[]

the list of results

getMaxListeners()​

getMaxListeners(): number

Defined in: packages/core/src/events/asynceventemitter.ts:90

Returns​

number

Inherited from​

AbstractService.getMaxListeners

getMetric()​

getMetric<T>(type, configuration): T

Defined in: packages/core/src/services/service.ts:310

Add service name label

Type Parameters​

T​

T = Gauge<string> | Counter<string> | Histogram<string>

Parameters​

type​

CustomConstructor<T, [MetricConfiguration<T>]>

the type to look up

configuration​

MetricConfiguration<T>

the configuration

Returns​

T

the result

getName()​

getName(): string

Defined in: packages/core/src/services/service.ts:483

Get service name

Returns​

string

the result string

Overrides​

AbstractService.getName

getOpenApiReplacements()​

getOpenApiReplacements(): any

Defined in: packages/core/src/services/service.ts:413

Return variables for replacement in openapi

Returns​

any

the result

Overrides​

AbstractService.getOpenApiReplacements

getOperationId()​

getOperationId(id): string

Defined in: packages/core/src/services/service.ts:371

If undefined is returned it cancel the operation registration

Parameters​

id​

string

the identifier

Returns​

string

the result

getParameters()​

getParameters(): T

Defined in: packages/core/src/services/service.ts:209

Get the service parameters

Returns​

T

the result

getService()​

getService<T>(name): ServicesMap[T]

Defined in: packages/core/src/services/service.ts:300

Get a service by name

Type Parameters​

T​

T extends keyof ServicesMap

Parameters​

name​

T

the name to use

Returns​

ServicesMap[T]

the result map

Deprecated​

Use useService, might reconsider

getState()​

getState(): ServiceStates

Defined in: packages/core/src/services/service.ts:172

Get the current state

Returns​

ServiceStates

the result

Overrides​

AbstractService.getState

getUrl()​

getUrl(url, _methods): string

Defined in: packages/core/src/services/service.ts:348

Return the full path url based on parameters

Parameters​

url​

string

relative url to service

_methods​

HttpMethodType[]

in case we need filtering (like Store)

Returns​

string

absolute url or undefined if need to skip the Route

init()​

abstract init(): Promise<Service<T, E>>

Defined in: packages/core/src/services/service.ts:463

Will be called after all the Services are created

Returns​

Promise<Service<T, E>>

Overrides​

AbstractService.init

initMetrics()​

initMetrics(): void

Defined in: packages/core/src/services/service.ts:290

Init the metrics

Returns​

void

initOperations()​

initOperations(): void

Defined in: packages/core/src/services/service.ts:420

Init the operations from

Returns​

void

Operation​

decorators on this service

listeners()​

listeners(eventName): Function[]

Defined in: packages/core/src/events/asynceventemitter.ts:183

Get all listeners for an event

Parameters​

eventName​

keyof E

the event name

Returns​

Function[]

the list of results

Inherited from​

AbstractService.listeners

loadCapabilities()​

protected loadCapabilities(): void

Defined in: packages/core/src/services/service.ts:270

Load capabilities from webda.module.json metadata into _compiledCapabilities.

Called during resolve after dependency injection. Reads the service's type name from parameters, looks it up in the application's module metadata (moddas or beans section), and populates _compiledCapabilities with an empty object for each declared capability name.

Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).

Returns​

void

Example​

// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }

See​

getCapabilities

log()​

log(level, ...args): void

Defined in: packages/core/src/services/service.ts:513

Parameters​

level​

WorkerLogLevel

to log

args​

...any[]

additional arguments

Returns​

void

off()​

off<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:141

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.off

Inherited from​

AbstractService.off

on()​

on<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:119

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

AbstractService.on

once()​

once<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:108

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.once

Inherited from​

AbstractService.once

removeAllListeners()​

removeAllListeners<Key>(eventName?): this

Defined in: packages/core/src/events/asynceventemitter.ts:150

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName?​

Key

the event name

Returns​

this

this for chaining

See​

EventEmitter.removeAllListeners

Inherited from​

AbstractService.removeAllListeners

removeListener()​

removeListener<Key>(eventName, listener): this

Defined in: packages/core/src/events/asynceventemitter.ts:130

Type Parameters​

Key​

Key extends string | number | symbol

Parameters​

eventName​

Key

the event name

listener​

(event) => void

the event listener

Returns​

this

this for chaining

See​

EventEmitter.removeListener

Inherited from​

AbstractService.removeListener

resolve()​

resolve(): this

Defined in: packages/core/src/services/service.ts:236

Resolve parameters and load metadata. @Route-declared routes are scanned and registered by Router.discoverRoutes(services) from Core.init() once every service has resolved — nothing to do per-service here.

Returns​

this

the result

Overrides​

AbstractService.resolve

setMaxListeners()​

setMaxListeners(n): this

Defined in: packages/core/src/events/asynceventemitter.ts:97

Parameters​

n​

number

Returns​

this

Inherited from​

AbstractService.setMaxListeners

stop()​

stop(): Promise<void>

Defined in: packages/core/src/services/service.ts:217

Shutdown the current service if action need to be taken

Returns​

Promise<void>

Overrides​

AbstractService.stop

toJSON()​

toJSON(): string

Defined in: packages/core/src/services/service.ts:452

Prevent service to be serialized

Returns​

string

the result

toString()​

toString(): string

Defined in: packages/core/src/services/service.ts:225

Return service representation

Returns​

string

the result