FileQueue
Class: FileQueue<T, K>
FIFO Queue on filesystem
Webda Modda
Extends
Queue<T,K>
Type parameters
• T = any
• K extends FileQueueParameters = FileQueueParameters
Constructors
new FileQueue(webda, name, params)
new FileQueue<
T,K>(webda,name,params):FileQueue<T,K>
Service
Parameters
• webda: Core<CoreEvents>
The main instance of Webda
• name: string
The name of the service
• params: DeepPartial<K>= {}
The parameters block define in the configuration file
Returns
FileQueue<T, K>
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
_timeout
protected_timeout:Timeout
Current timeout handler
Inherited from
Source
packages/core/src/queues/queueservice.ts:69
_webda
protected_webda:Core<CoreEvents>
Webda Core object
Inherited from
Source
packages/core/src/services/service.ts:304
delayer
protecteddelayer:WaitDelayer
Delayer
Inherited from
Source
packages/core/src/queues/queueservice.ts:81
eventPrototype
eventPrototype: () =>
T
Returns
T
Inherited from
Source
packages/core/src/queues/queueservice.ts:82
failedIterations
protectedfailedIterations:number
Current pause instance
Inherited from
Source
packages/core/src/queues/queueservice.ts:77
logger
protectedlogger:Logger
Logger with class context
Inherited from
Source
packages/core/src/services/service.ts:321
metrics
protectedmetrics:Object
Type declaration
errors
errors:
Counter<string>
messages_pending
messages_pending:
Gauge<string>
messages_received
messages_received:
Counter<string>
messages_sent
messages_sent:
Counter<string>
processing_duration
processing_duration:
Histogram<string>
Inherited from
Source
packages/core/src/queues/pubsubservice.ts:12
parameters
protectedparameters:K
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
captureRejectionSymbol
staticreadonlycaptureRejectionSymbol: typeofcaptureRejectionSymbol
Inherited from
Source
packages/core/node_modules/@types/node/events.d.ts:328
captureRejections
staticcaptureRejections: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
staticdefaultMaxListeners:number
Inherited from
Source
packages/core/node_modules/@types/node/events.d.ts:334
errorMonitor
staticreadonlyerrorMonitor: 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>
Overrides
Abstract
Source
packages/core/src/queues/filequeue.ts:145
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
Create the storage folder if does not exist
Returns
void
Overrides
Source
packages/core/src/queues/filequeue.ts:43
consume()
consume(
callback,eventPrototype?):CancelablePromise<void>
Work a queue calling the callback with every Event received
If the callback is called without exception the deleteMessage is called
Parameters
• callback: (event) => Promise<void>
• eventPrototype?: () => T
Returns
CancelablePromise<void>
Inherited from
Source
packages/core/src/queues/queueservice.ts:172
consumerReceiveMessage()
protectedconsumerReceiveMessage():Promise<Object>
Receive and process message from the queue
Returns
Promise<Object>
items
items:
numberspeed
speed:
number
Inherited from
Source
packages/core/src/queues/queueservice.ts:109
deleteMessage()
deleteMessage(
receipt):Promise<void>
Delete one message based on its receipt
Parameters
• receipt: any
Returns
Promise<void>
Overrides
Source
packages/core/src/queues/filequeue.ts:132
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
getFile()
getFile(
uid):string
Return file
Parameters
• uid: string
Returns
string
Source
packages/core/src/queues/filequeue.ts:62
getMaxConsumers()
getMaxConsumers():
number
Return the max consumers for the queue
It is overridable so if a queue can retrieve several message at once it can just use the worker // and several messages at once
SQS for example will return this.parameters.maxConsumers / 10
Returns
number
Inherited from
Source
packages/core/src/queues/queueservice.ts:162
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
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():
K
Get the service parameters
Returns
K
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<FileQueue<T,K>>
Will be called after all the Services are created
Returns
Promise<FileQueue<T, K>>
Inherited from
Abstract
Source
packages/core/src/services/service.ts:570
initMetrics()
initMetrics():
void
Returns
void
Inherited from
Source
packages/core/src/queues/pubsubservice.ts:22
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: any
Returns
Overrides
Source
packages/core/src/queues/filequeue.ts:36
log()
log(
level, ...args):void
Parameters
• level: WorkerLogLevel
to log
• ...args: any[]