Module redis

Index

Interfaces

PubSubMessage

Functions

Functions

doCluster

doCluster(method: string, args?: Array<any>, connectionId?: string, waitForResponse?: boolean): Promise<unknown>

- Defined in src/modules/redis.ts:29
Invoke a command on all servers in this cluster.

Parameters
- method: string
- Default value args: Array<any> = []
- Optional connectionId: string
- Default value waitForResponse: boolean = false
Returns Promise<unknown>

publish

publish(payload: object | Array<any>): Promise<number>

- Defined in src/modules/redis.ts:21
Publish a message to all other ActionHero nodes in the cluster. Will be authenticated against api.config.serverToken
```
let payload = {
  messageType: 'myMessageType',
  serverId: api.id,
  serverToken: api.config.general.serverToken,
  message: 'hello!'
}
await api.redis.publish(payload)
```
Parameters
- payload: object | Array<any>
Returns Promise<number>

respondCluster

respondCluster(messageId: string, response: PubSubMessage): Promise<void>

- Defined in src/modules/redis.ts:69
Parameters
- messageId: string
- response: PubSubMessage
Returns Promise<void>

Generated using TypeDoc