Class: ExternalStorage

Experimental

Configuration for external storage. Holds the registered drivers, an optional selector, and the size threshold above which payloads are eligible for offloading to external storage. A selector function is required when more than one driver is registered.

Constructors

Constructor

new ExternalStorage(__namedParameters): ExternalStorage

Experimental

Parameters

__namedParameters

concurrency?

ExternalStorageConcurrency

Omit for defaults (100 instance-wide, 10 per message).

drivers

StorageDriver[]

driverSelector?

StorageDriverSelector

payloadSizeThreshold?

number

Omit for default (256 KiB). Set 0 to consider all payloads regardless of size.

Returns

ExternalStorage

Properties

concurrency

readonly concurrency: Required<ExternalStorageConcurrency>

Experimental

---

drivers

readonly drivers: StorageDriver[]

Experimental

---

driverSelector

readonly driverSelector: StorageDriverSelector

Experimental

Selects the destination driver for each payload, or returns null to keep the payload inline.

---

payloadSizeThreshold

readonly payloadSizeThreshold: number

Experimental

Methods

getDriver()

getDriver(name): StorageDriver | null

Experimental

Look up a registered driver by name. Returns null if no driver with that name is registered.

Parameters

name

string

Returns

StorageDriver | null