Class RedisQueue

Class RedisQueue Implements simple messaging queue over redis.

Hierarchy

EventEmitter
- RedisQueue

Implements

IMessageQueue

Indexable

[name: string]: any

Class RedisQueue Implements simple messaging queue over redis.

Index

Constructors

constructor

Properties

Constructors

constructor

new RedisQueue(name: string, options?: Partial<IMQOptions>): RedisQueue

- Defined in src/RedisQueue.ts:278
constructor

Parameters
- name: string
- Optional options: Partial<IMQOptions>
Returns RedisQueue

Properties

name

name: string

options

options: IMQOptions

This queue instance options

type: {IMQOptions}

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:1050
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

clear

clear(): Promise<RedisQueue>

Implementation of IMessageQueue.clear
- Defined in src/RedisQueue.ts:476
Clears queue data in redis;

Returns Promise<RedisQueue>

destroy

destroy(): Promise<void>

Implementation of IMessageQueue.destroy
- Defined in src/RedisQueue.ts:461
Gracefully destroys this queue

Returns Promise<void>

emit

emit(event: string | symbol, ...args: any[]): boolean

Implementation of IMessageQueue.emit

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:1062
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Implementation of IMessageQueue.eventNames

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/index.d.ts:1063
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Implementation of IMessageQueue.getMaxListeners

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1059
Returns number

listenerCount

listenerCount(type: string | symbol): number

Implementation of IMessageQueue.listenerCount

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1064
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Implementation of IMessageQueue.listeners

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/index.d.ts:1060
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/index.d.ts:1056
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:1051
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:1052
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:1053
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:1054
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Implementation of IMessageQueue.rawListeners

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/index.d.ts:1061
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of IMessageQueue.removeAllListeners

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/index.d.ts:1057
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:1055
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(toQueue: string, message: IJson, delay?: undefined | number, errorHandler?: undefined | function): Promise<string>

- Defined in src/RedisQueue.ts:363
Sends given message to a given queue (by name)

Parameters
- toQueue: string
- message: IJson
- Optional delay: undefined | number
- Optional errorHandler: undefined | function
Returns Promise<string>

setMaxListeners

setMaxListeners(n: number): this

Implementation of IMessageQueue.setMaxListeners

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1058
Parameters
- n: number
Returns this

start

start(): Promise<RedisQueue>

Implementation of IMessageQueue.start
- Defined in src/RedisQueue.ts:308
Initializes and starts current queue routines

Returns Promise<RedisQueue>

stop

stop(): Promise<RedisQueue>

Implementation of IMessageQueue.stop
- Defined in src/RedisQueue.ts:412
Stops current queue routines

Returns Promise<RedisQueue>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Implementation of IMessageQueue.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1047
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number