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



# Class: CollabAuthority\<Transaction> [#class-collabauthoritytransaction]

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

The CollabAuthority manages most of Pitter Patter's server side collaborative editing operations.

You create endpoints that call the appropriate CollabAuthority functions to integrate with a
CollabClient.

A CollabAuthority is designed to be stateless, so you can create a new one on every server, lambda,
or cloud function instance.

## Type Parameters [#type-parameters]

### Transaction [#transaction]

`Transaction`

## Constructors [#constructors]

### Constructor [#constructor]

```ts
new CollabAuthority<Transaction>(config: CollabAuthorityConfig<Transaction>): CollabAuthority<Transaction>;
```

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

#### Parameters [#parameters]

##### config [#config]

[`CollabAuthorityConfig`](/docs/collab/reference/collab-server/interfaces/CollabAuthorityConfig)\<`Transaction`>

#### Returns [#returns]

`CollabAuthority`\<`Transaction`>

## Methods [#methods]

### listenForCommit() [#listenforcommit]

```ts
listenForCommit(docId: string, version: number): Promise<CommitJSON[]>;
```

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

Listens for remote changes to a document's editor state and returns when changes are found or after
a timeout specified in the CollabAuthority's `broadcastManager`.

#### Parameters [#parameters-1]

##### docId [#docid]

`string`

##### version [#version]

`number`

#### Returns [#returns-1]

`Promise`\<`CommitJSON`\[]>

***

### receiveCommit() [#receivecommit]

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

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

Receives a commit from a CollabClient and merges it into the remote editor state.

#### Parameters [#parameters-2]

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

`string`

##### commitJSON [#commitjson]

`CommitJSON`

#### Returns [#returns-2]

`Promise`\<`void`>

***

### runWithTransactionRetries() [#runwithtransactionretries]

```ts
runWithTransactionRetries<Result>(callback: (tr: Transaction) => Promise<Result>): Promise<Result>;
```

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

#### Type Parameters [#type-parameters-1]

##### Result [#result]

`Result`

#### Parameters [#parameters-3]

##### callback [#callback]

(`tr`: `Transaction`) => `Promise`\<`Result`>

#### Returns [#returns-3]

`Promise`\<`Result`>