BoundedMailboxOptionsBuilder

Defined in: src/mailbox/BoundedMailboxOptions.ts:36

Fluent builder for BoundedMailboxOptionsType:

new BoundedMailbox(BoundedMailboxOptions.create()
  .withCapacity(1000)
  .withOverflow('drop-head'));

Extends

• OptionsBuilder<BoundedMailboxOptionsType>

Constructors

Constructor

new BoundedMailboxOptionsBuilder(): BoundedMailboxOptionsBuilder

Returns

BoundedMailboxOptionsBuilder

Inherited from

OptionsBuilder.constructor

Methods

build()

build(): Partial<T>

Defined in: src/util/OptionsBuilder.ts:51

Snapshot the set fields as an independent Partial<T> (own props only).

Returns

Partial<T>

Inherited from

OptionsBuilder.build

---

withCapacity()

withCapacity(capacity): this

Defined in: src/mailbox/BoundedMailboxOptions.ts:43

Maximum queued user messages. Must be >= 1.

Parameters

capacity

number

Returns

this

---

withOnDrop()

withOnDrop(onDrop): this

Defined in: src/mailbox/BoundedMailboxOptions.ts:53

Hook fired on each overflow drop (for metrics).

Parameters

onDrop

(reason) => void

Returns

this

---

withOverflow()

withOverflow(overflow): this

Defined in: src/mailbox/BoundedMailboxOptions.ts:48

What to do when a message arrives on a full mailbox. Default reject.

Parameters

overflow

BoundedMailboxOverflow

Returns

this

---

create()

static create(): BoundedMailboxOptionsBuilder

Defined in: src/mailbox/BoundedMailboxOptions.ts:38

Start a fresh builder.

Returns

BoundedMailboxOptionsBuilder