Interface: PasswordVerifier
Implement a PasswordVerifier so you can implement your own rules
Extends
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
protectedlogger:Logger
Logger with class context
Inherited from
Source
packages/core/src/services/service.ts:321
metrics?
protectedmetrics?:any
Get metrics
Inherited from
Source
packages/core/src/services/service.ts:325
parameters
protectedparameters:ServiceParameters
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
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
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()
protectedaddRoute(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
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 Symbols.
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
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():
ServiceParameters
Get the service parameters
Returns
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
init()
init():
Promise<PasswordVerifier>
Will be called after all the Services are created
Returns
Promise<PasswordVerifier>
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
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):ServiceParameters
Load the parameters for a service
Parameters
• params: DeepPartial<ServiceParameters>
Returns
Inherited from
Source
packages/core/src/services/service.ts:345
log()
log(
level, ...args):void
Parameters
• level: WorkerLogLevel
to log
• ...args: any[]
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:662
off()
off(
eventName,listener):this
Alias for emitter.removeListener().
Parameters
• eventName: string | symbol
• listener: (...args) => void
Returns
this
Inherited from
Since
v10.0.0
Source
packages/core/node_modules/@types/node/events.d.ts:499
on()
on<
Key>(event,listener):this
Type the listener part
Type parameters
• Key extends string | number
Parameters
• event: symbol | Key
• listener: (evt) => void
Returns
this
Inherited from
Source
packages/core/src/services/service.ts:607
onAsync()
onAsync<
Key>(event,listener,queue):void
Listen to an event as on(...) would do except that it will be asynchronous
Type parameters
• Key extends string | number
Parameters
• event: Key
• listener: (evt) => void
• queue: string= undefined
Name of queue to use, can be undefined, queue name are used to define differents priorities
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:618
once()
once(
eventName,listener):this
Adds a one-timelistener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
Parameters
• eventName: string | symbol
The name of the event.
• listener: (...args) => void
The callback function
Returns
this
Inherited from
Since
v0.3.0
Source
packages/core/node_modules/@types/node/events.d.ts:414
prependListener()
prependListener(
eventName,listener):this
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple
times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
• eventName: string | symbol
The name of the event.
• listener: (...args) => void
The callback function
Returns
this
Inherited from
Since
v6.0.0
Source
packages/core/node_modules/@types/node/events.d.ts:634
prependOnceListener()
prependOnceListener(
eventName,listener):this
Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
• eventName: string | symbol
The name of the event.
• listener: (...args) => void
The callback function
Returns
this
Inherited from
Since
v6.0.0
Source
packages/core/node_modules/@types/node/events.d.ts:650
rawListeners()
rawListeners(
eventName):Function[]
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
Parameters
• eventName: string | symbol
Returns
Function[]
Inherited from
Since
v9.4.0
Source
packages/core/node_modules/@types/node/events.d.ts:569
reinit()
reinit(
config):Promise<PasswordVerifier>
Parameters
• config: DeepPartial<ServiceParameters>
new parameters for the service
Returns
Promise<PasswordVerifier>
Inherited from
Source
packages/core/src/services/service.ts:579
removeAllListeners()
removeAllListeners(
event?):this
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
• event?: string | symbol
Returns
this
Inherited from
Since
v0.1.26
Source
packages/core/node_modules/@types/node/events.d.ts:510
removeListener()
removeListener(
eventName,listener):this
Removes the specified listener from the listener array for the event namedeventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener() must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and before the last listener finishes execution
will not remove them fromemit() in progress. Subsequent events behave as expected.
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single
event (as in the example below), removeListener() will remove the most
recently added instance. In the example the once('ping')listener is removed:
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
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:494
resolve()
resolve():
this
Resolve parameters Call initRoutes and initBeanRoutes
Returns
this
Inherited from
Source
packages/core/src/services/service.ts:388
setMaxListeners()
setMaxListeners(
n):this
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
• n: number
Returns
this
Inherited from
Since
v0.3.5
Source
packages/core/node_modules/@types/node/events.d.ts:520
stop()
stop():
Promise<void>
Shutdown the current service if action need to be taken
Returns
Promise<void>
Inherited from
Source
packages/core/src/services/service.ts:373
toJSON()
toJSON():
string
Prevent service to be serialized
Returns
string
Inherited from
Source
packages/core/src/services/service.ts:560
toPublicJSON()
toPublicJSON(
object):string
Convert an object to JSON using the Webda json filter
Parameters
• object: unknown
The object to export
Returns
string
The export of the strip object ( removed all attribute with _ )
Inherited from
Source
packages/core/src/services/service.ts:552
toString()
toString():
string
Return service representation
Returns
string
Inherited from
Source
packages/core/src/services/service.ts:380
validate()
validate(
password,user?):Promise<boolean>
If the password is not valid, send a 400 exception or return false
Parameters
• password: string
to verify
• user?: User
to verify from
Returns
Promise<boolean>