Namespace redis

Index

Interfaces

PubSubMessage

Functions

Functions

doCluster

doCluster<T>(method: string, args?: any[], connectionId?: string, waitForResponse?: boolean): Promise<T extends any ? T : unknown>

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

Type Parameters
- T
Parameters
- method: string
- args: any[] = []
- Optional connectionId: string
- waitForResponse: boolean = false
Returns Promise<T extends any ? T : unknown>

publish

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

- Defined in src/modules/redis.ts:22
Publish a message to all other Actionhero nodes in the cluster. Will be authenticated against api.config.serverToken

```js let payload = { messageType: 'myMessageType', serverId: api.id, serverToken: api.config.general.serverToken, message: 'hello!' }
await api.redis.publish(payload)
Parameters
- payload: object | any[]
Returns Promise<number>

respondCluster

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

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

Generated using TypeDoc