Documentation

Class: PubSub

arpen/services/pubsub~ PubSub

PubSub service

new PubSub(app)

Create the service
Parameters:
Name Type Description
app App The application

Members

<static> provides :string

Service name is 'pubsub'
Type:
  • string

<static> requires :Array.<string>

Dependencies as constructor arguments
Type:
  • Array.<string>

<static> lifecycle :string

This service is a singleton
Type:
  • string

<static> client

PUBSUB client class

Methods

<async> connect( [serverName] [, subscriberName] [, cacheName])

Get pubsub client
Parameters:
Name Type Argument Default Description
serverName string <optional>
 'redis.main' Server name as in config, default is 'redis.main'
subscriberName string | null <optional>
 null This subscriber name
cacheName string | null <optional>
 null Store and later reuse this pubsub client under this name
Returns:
Resolves to pubsub client instance
Type
Promise