Class: MapperService<T>
Map object to another object
Webda Modda
Mapper
Extends
Service
<T
>
Type parameters
• T extends MapperParameters
= MapperParameters
Constructors
new MapperService(webda, name, params)
new MapperService<
T
>(webda
,name
,params
):MapperService
<T
>
Parameters
• webda: Core
<CoreEvents
>
The main instance of Webda
• name: string
The name of the service
• params: DeepPartial
<T
>= {}
The parameters block define in the configuration file
Returns
Inherited from
Source
packages/core/src/services/service.ts:334
Properties
_createException
_createException:
string
Inherited from
Source
packages/core/src/services/service.ts:315
_initException
_initException:
any
=undefined
Inherited from
Source
packages/core/src/services/service.ts:317
_initTime
_initTime:
number
Inherited from
Source
packages/core/src/services/service.ts:316
_name
protected
_name:string
Service name
Inherited from
Source
packages/core/src/services/service.ts:308
_webda
protected
_webda:Core
<CoreEvents
>
Webda Core object
Inherited from
Source
packages/core/src/services/service.ts:304
logger
protected
logger:Logger
Logger with class context
Inherited from
Source
packages/core/src/services/service.ts:321
metrics?
protected
metrics?:any
Get metrics
Inherited from
Source
packages/core/src/services/service.ts:325
parameters
protected
parameters:T
Hold the parameters for your service
It will be bring from the webda.config.json
Inherited from
Source
packages/core/src/services/service.ts:314
sourceService
sourceService:
Store
<CoreModel
,StoreParameters
,StoreEvents
>
Source
packages/core/src/stores/mapper.ts:71
targetStore
targetStore:
Store
<CoreModel
&Object
,StoreParameters
,StoreEvents
>
Source
packages/core/src/stores/mapper.ts:68
captureRejectionSymbol
static
readonly
captureRejectionSymbol: typeofcaptureRejectionSymbol
Inherited from
Service
.captureRejectionSymbol
Source
packages/core/node_modules/@types/node/events.d.ts:328
captureRejections
static
captureRejections:boolean
Sets or gets the default captureRejection value for all emitters.
Inherited from
Source
packages/core/node_modules/@types/node/events.d.ts:333
defaultMaxListeners
static
defaultMaxListeners:number
Inherited from
Source
packages/core/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
Source
packages/core/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
Abstract
Source
packages/core/src/services/service.ts:642
_handleCreatedMap()
_handleCreatedMap(
source
,target
):Promise
<Date
>
Add the mapper for a newly created object
Parameters
• source: CoreModel
• target: CoreModel
Returns
Promise
<Date
>
Source
packages/core/src/stores/mapper.ts:240
_handleDeletedMap()
_handleDeletedMap(
source
,target
):Promise
<Date
>
Remove the mapper for a deleted object
Parameters
• source: CoreModel
• target: CoreModel
Returns
Promise
<Date
>
Source
packages/core/src/stores/mapper.ts:216
_handleMapFromPartial()
_handleMapFromPartial(
uid
,updateDate
,property
):Promise
<void
>
Handle the map from a partial update
Parameters
• uid: string
• updateDate: Date
• property: string
| string
[]= undefined
Returns
Promise
<void
>
Source
packages/core/src/stores/mapper.ts:263
_handleUpdatedMap()
_handleUpdatedMap(
source
,target
,updates
):Promise
<Date
>
Update a mapper after source object was modified
Parameters
• source: CoreModel
• target: CoreModel
• updates: any
Returns
Promise
<Date
>
Source
packages/core/src/stores/mapper.ts:172
_handleUpdatedMapMapper()
_handleUpdatedMapMapper(
source
,target
,mapper
):Promise
<Date
>
Update a mapper after source object was modified without change in target
Parameters
• source: CoreModel
• target: CoreModel
• mapper: Mapper
Returns
Promise
<Date
>
Source
packages/core/src/stores/mapper.ts:191
addListener()
addListener(
eventName
,listener
):this
Alias for emitter.on(eventName, listener)
.
Parameters
• eventName: string
| symbol
• listener: (...args
) => void
Returns
this
Inherited from
Since
v0.1.26
Source
packages/core/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
= false
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:482
authorizeClientEvent()
authorizeClientEvent(
_event
,_context
):boolean
Authorize a public event subscription
Parameters
• _event: string
• _context: OperationContext
<any
, any
>
Returns
boolean
Inherited from
Source
packages/core/src/services/service.ts:438
computeParameters()
computeParameters():
void
Used to compute or derivate input parameter to attribute
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:352
createMapper()
createMapper(
object
,updates
): [Mapper
,boolean
]
Create an object mapper
Parameters
• object: CoreModel
for the mapper to represent
• updates: any
to the object being made
Returns
[Mapper
, boolean
]
mapper object and found = true if updates will impact the mapper
Source
packages/core/src/stores/mapper.ts:146
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
Source
packages/core/src/services/service.ts:596
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
Source
packages/core/src/services/service.ts:588
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
Since
v6.0.0
Source
packages/core/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
Source
packages/core/src/services/service.ts:429
getMapper()
getMapper(
map
,uuid
):number
Get index of the mapper for an object
Parameters
• map: any
[]
• uuid: string
Returns
number
Source
packages/core/src/stores/mapper.ts:129
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
Since
v1.0.0
Source
packages/core/node_modules/@types/node/events.d.ts:526
getMetric()
getMetric<
T
>(type
,configuration
):T
Add service name label
Type parameters
• T = Counter
<string
> | Histogram
<string
> | Gauge
<string
>
Parameters
• type: Constructor
<T
, [MetricConfiguration
<T
>]>
• configuration: MetricConfiguration
<T
>
Returns
T
Inherited from
Source
packages/core/src/services/service.ts:414
getName()
getName():
string
Get service name
Returns
string
Inherited from
Source
packages/core/src/services/service.ts:633
getOpenApiReplacements()
getOpenApiReplacements():
any
Return variables for replacement in openapi
Returns
any
Inherited from
Service
.getOpenApiReplacements
Source
packages/core/src/services/service.ts:507
getOperationId()
getOperationId(
id
):string
If undefined is returned it cancel the operation registration
Parameters
• id: string
Returns
string
Inherited from
Source
packages/core/src/services/service.ts:471
getParameters()
getParameters():
T
Get the service parameters
Returns
T
Inherited from
Source
packages/core/src/services/service.ts:359
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
Source
packages/core/src/services/service.ts:626
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
Source
packages/core/src/services/service.ts:449
getWebda()
getWebda():
Core
<CoreEvents
>
Return WebdaCore
Returns
Inherited from
Source
packages/core/src/services/service.ts:366
handleMap()
handleMap(
object
,updates
):Promise
<void
>
Manage one mapping update
Parameters
• object: CoreModel
• updates: MapUpdates
Returns
Promise
<void
>
Source
packages/core/src/stores/mapper.ts:292
init()
init():
Promise
<MapperService
<T
>>
Will be called after all the Services are created
Returns
Promise
<MapperService
<T
>>
Inherited from
Abstract
Source
packages/core/src/services/service.ts:570
initMetrics()
initMetrics():
void
Init the metrics
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:404
initOperations()
initOperations():
void
Init the operations
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:528
initRoutes()
initRoutes():
void
Init the routes
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:514
isMapped()
isMapped(
property
):boolean
Return true if property belongs to the mapped properties
Parameters
• property: string
Returns
boolean
Source
packages/core/src/stores/mapper.ts:252
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
Since
v3.2.0
Source
packages/core/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
Since
v0.1.26
Source
packages/core/node_modules/@types/node/events.d.ts:539
loadParameters()
loadParameters(
params
):MapperParameters
Parameters
• params: any
Returns
Overrides
Source
packages/core/src/stores/mapper.ts:76
log()
log(
level
, ...args
):void
Parameters
• level: WorkerLogLevel
to log
• ...args: any
[]
Returns
void