# RedisBroadcastManager (/docs/collab/reference/collab-server/classes/RedisBroadcastManager)



# Class: RedisBroadcastManager [#class-redisbroadcastmanager]

Defined in:
[packages/collab-server/src/index.ts:230](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/collab-server/src/index.ts#L230)

A broadcast manager that uses a Redis cluster as a message broker via Redis's pub/sub.

When a client connects it specifies the document id to listen to.

When changes are submitted to a document all listeners for that document id are notified that there
is an update.

## Constructors [#constructors]

### Constructor [#constructor]

```ts
new RedisBroadcastManager(config: RedisBroadcastManagerConfig): RedisBroadcastManager;
```

Defined in:
[packages/collab-server/src/index.ts:235](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/collab-server/src/index.ts#L235)

#### Parameters [#parameters]

##### config [#config]

[`RedisBroadcastManagerConfig`](/docs/collab/reference/collab-server/interfaces/RedisBroadcastManagerConfig)

#### Returns [#returns]

`RedisBroadcastManager`

## Methods [#methods]

### broadcastCommit() [#broadcastcommit]

```ts
broadcastCommit(docId: string, commitJSON: CommitJSON): Promise<void>;
```

Defined in:
[packages/collab-server/src/index.ts:252](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/collab-server/src/index.ts#L252)

#### Parameters [#parameters-1]

##### docId [#docid]

`string`

##### commitJSON [#commitjson]

`CommitJSON`

#### Returns [#returns-1]

`Promise`\<`void`>

***

### connect() [#connect]

```ts
connect(): Promise<void>;
```

Defined in:
[packages/collab-server/src/index.ts:248](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/collab-server/src/index.ts#L248)

#### Returns [#returns-2]

`Promise`\<`void`>

***

### createCommitListener() [#createcommitlistener]

```ts
createCommitListener(docId: string, version: number): Promise<{
  abort: () => Promise<void>;
  listen: () => Promise<boolean>;
}>;
```

Defined in:
[packages/collab-server/src/index.ts:256](https://github.com/handlewithcarecollective/pitter-patter/blob/81896664a0707dea093e9edc81dae89a35a20ad2/packages/collab-server/src/index.ts#L256)

#### Parameters [#parameters-2]

##### docId [#docid-1]

`string`

##### version [#version]

`number`

#### Returns [#returns-3]

`Promise`\<\{ `abort`: () => `Promise`\<`void`>; `listen`: () => `Promise`\<`boolean`>; }>