Skip to content

Commit fe83f6d

Browse files
committed
Docs: Document Heart configuration options and defaults (#56)
1 parent 420306f commit fe83f6d

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/api/API_REFERENCE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,8 +315,8 @@ class Heart extends EventEmitter {
315315
**Options**:
316316
```typescript
317317
interface HeartOptions {
318-
persistence?: boolean - Whether to persist messages (optional).
319-
maxQueueSize?: number - The maximum capacity of the message queue (optional).
318+
persistence?: boolean - Whether to persist messages. Defaults to `false`.
319+
maxQueueSize?: number - The maximum capacity of the message queue. Defaults to `Infinity` (unbounded).
320320
}
321321
```
322322

0 commit comments

Comments
 (0)