Class: EchoService
Return a static string with a static route
Useful for version display {@VersionService } is a shortcut for this
"Version": {
"type": "Webda/EchoService",
"result": "${package.version}",
"url": "/version",
"mime": "text/plain"
}
Webda Modda
Extends
Service
<EchoServiceParameters
>
Constructors
new EchoService(webda, name, params)
new EchoService(
webda
,name
,params
?):EchoService
Parameters
• webda: Core
<CoreEvents
>
The main instance of Webda
• name: string
The name of the service
• params?: DeepPartial
<EchoServiceParameters
>
The parameters block define in the configuration file
Returns
Inherited from
Service<EchoServiceParameters>.constructor
Source
core/lib/services/service.d.ts:168
Properties
_createException
_createException:
string
Inherited from
Service._createException
Source
core/lib/services/service.d.ts:149
_initException
_initException:
any
Inherited from
Service._initException
Source
core/lib/services/service.d.ts:151
_initTime
_initTime:
number
Inherited from
Service._initTime
Source
core/lib/services/service.d.ts:150
_name
protected
_name:string
Service name
Inherited from
Service._name
Source
core/lib/services/service.d.ts:142
_webda
protected
_webda:Core
<CoreEvents
>
Webda Core object
Inherited from
Service._webda
Source
core/lib/services/service.d.ts:138
logger
protected
logger:Logger
Logger with class context
Inherited from
Service.logger
Source
core/lib/services/service.d.ts:155
metrics?
protected
metrics?:any
Get metrics
Inherited from
Service.metrics
Source
core/lib/services/service.d.ts:159
parameters
protected
parameters:EchoServiceParameters
Hold the parameters for your service
It will be bring from the webda.config.json
Inherited from
Service.parameters
Source
core/lib/services/service.d.ts:148
captureRejectionSymbol
static
readonly
captureRejectionSymbol: typeofcaptureRejectionSymbol
Inherited from
Service.captureRejectionSymbol
Source
runtime/node_modules/@types/node/events.d.ts:328
captureRejections
static
captureRejections:boolean
Sets or gets the default captureRejection value for all emitters.
Inherited from
Service.captureRejections
Source
runtime/node_modules/@types/node/events.d.ts:333
defaultMaxListeners
static
defaultMaxListeners:number
Inherited from
Service.defaultMaxListeners
Source
runtime/node_modules/@types/node/events.d.ts:334
errorMonitor
static
readonly
errorMonitor: typeoferrorMonitor
This symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error'
listeners are called.
Installing a listener using this symbol does not change the behavior once an
'error'
event is emitted, therefore the process will still crash if no
regular 'error'
listener is installed.
Inherited from
Service.errorMonitor
Source
runtime/node_modules/@types/node/events.d.ts:327
Methods
__clean()
__clean():
Promise
<void
>
Clean the service data, can only be used in test mode
Returns
Promise
<void
>
Inherited from
Service.__clean
Abstract
Source
core/lib/services/service.d.ts:319
addListener()
addListener(
eventName
,listener
):this
Alias for emitter.on(eventName, listener)
.
Parameters
• eventName: string
| symbol
• listener: (...args
) => void
Returns
this
Inherited from
Service.addListener
Since
v0.1.26
Source
runtime/node_modules/@types/node/events.d.ts:354
addRoute()
protected
addRoute(url
,methods
,executer
,openapi
?,override
?):void
Add a route dynamicaly
Parameters
• url: string
of the route can contains dynamic part like {uuid}
• methods: HttpMethodType
[]
• executer: Function
Method to execute for this route
• openapi?: OpenAPIWebdaDefinition
• override?: boolean
Returns
void
Inherited from
Service.addRoute
Source
core/lib/services/service.d.ts:242
authorizeClientEvent()
authorizeClientEvent(
_event
,_context
):boolean
Authorize a public event subscription
Parameters
• _event: string
• _context: OperationContext
<any
, any
>
Returns
boolean
Inherited from
Service.authorizeClientEvent
Source
core/lib/services/service.d.ts:220
computeParameters()
computeParameters():
void
Used to compute or derivate input parameter to attribute
Returns
void
Inherited from
Service.computeParameters
Source
core/lib/services/service.d.ts:176
emit()
emit<
Key
>(event
,data
):boolean
Override to allow capturing long listeners
Type parameters
• Key extends string
| number
Parameters
• event: symbol
| Key
• data: Events
[Key
]
Returns
boolean
Inherited from
Service.emit
Source
core/lib/services/service.d.ts:289
emitSync()
emitSync<
Key
>(event
,data
):Promise
<any
[]>
Emit the event with data and wait for Promise to finish if listener returned a Promise
Type parameters
• Key extends string
| number
Parameters
• event: Key
• data: Events
[Key
]
Returns
Promise
<any
[]>
Inherited from
Service.emitSync
Source
core/lib/services/service.d.ts:284
eventNames()
eventNames(): (
string
|symbol
)[]
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbol
s.
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
Returns
(string
| symbol
)[]
Inherited from
Service.eventNames
Since
v6.0.0
Source
runtime/node_modules/@types/node/events.d.ts:669
getClientEvents()
getClientEvents():
string
[]
Return the events that an external system can subscribe to
Returns
string
[]
Inherited from
Service.getClientEvents
Source
core/lib/services/service.d.ts:214
getMaxListeners()
getMaxListeners():
number
Returns the current max listener value for the EventEmitter
which is either
set by emitter.setMaxListeners(n)
or defaults to defaultMaxListeners.
Returns
number
Inherited from
Service.getMaxListeners
Since
v1.0.0
Source
runtime/node_modules/@types/node/events.d.ts:526
getMetric()
getMetric<
T
>(type
,configuration
):T
Add service name label
Type parameters
• T = Gauge
<string
> | Counter
<string
> | Histogram
<string
>
Parameters
• type: Constructor
<T
, [MetricConfiguration
<T
>]>
• configuration: MetricConfiguration
<T
>
Returns
T
Inherited from
Service.getMetric
Source
core/lib/services/service.d.ts:208
getName()
getName():
string
Get service name
Returns
string
Inherited from
Service.getName
Source
core/lib/services/service.d.ts:313
getOpenApiReplacements()
getOpenApiReplacements():
any
Return variables for replacement in openapi
Returns
any
Inherited from
Service.getOpenApiReplacements
Source
core/lib/services/service.d.ts:247
getOperationId()
getOperationId(
id
):string
If undefined is returned it cancel the operation registration
Parameters
• id: string
Returns
string
Inherited from
Service.getOperationId
Source
core/lib/services/service.d.ts:234
getParameters()
getParameters():
EchoServiceParameters
Get the service parameters
Returns
Inherited from
Service.getParameters
Source
core/lib/services/service.d.ts:180
getService()
getService<
K
>(service
):K
Return a webda service
Type parameters
• K extends Service
<ServiceParameters
, Events
>
Parameters
• service: string
name to retrieve
Returns
K
Inherited from
Service.getService
Source
core/lib/services/service.d.ts:309
getUrl()
getUrl(
url
,_methods
):string
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
Inherited from
Service.getUrl
Source
core/lib/services/service.d.ts:228
getWebda()
getWebda():
Core
<CoreEvents
>
Return WebdaCore
Returns
Core
<CoreEvents
>
Inherited from
Service.getWebda
Source
core/lib/services/service.d.ts:184
init()
init():
Promise
<EchoService
>
Will be called after all the Services are created
Returns
Promise
<EchoService
>
Inherited from
Service.init
Abstract
Source
core/lib/services/service.d.ts:275
initMetrics()
initMetrics():
void
Init the metrics
Returns
void
Inherited from
Service.initMetrics
Source
core/lib/services/service.d.ts:201
initOperations()
initOperations():
void
Init the operations
Returns
void
Inherited from
Service.initOperations
Source
core/lib/services/service.d.ts:255
listenerCount()
listenerCount(
eventName
):number
Returns the number of listeners listening to the event named eventName
.
Parameters
• eventName: string
| symbol
The name of the event being listened for
Returns
number
Inherited from
Service.listenerCount
Since
v3.2.0
Source
runtime/node_modules/@types/node/events.d.ts:616
listeners()
listeners(
eventName
):Function
[]
Returns a copy of the array of listeners for the event named eventName
.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
Parameters
• eventName: string
| symbol
Returns
Function
[]
Inherited from
Service.listeners
Since
v0.1.26