Interface: ProjectQuota
@roomful/relay / ProjectQuota
Interface: ProjectQuota
Section titled “Interface: ProjectQuota”Defined in: packages/relay/src/management/types.ts:122
Per-project resource limits. A project that has no explicit quota inherits the relay-wide defaults (which may themselves be unlimited).
A value of -1 means unlimited; undefined inherits the relay default.
Properties
Section titled “Properties”maxEphemeralTtlMs
Section titled “maxEphemeralTtlMs”maxEphemeralTtlMs:
number|undefined
Defined in: packages/relay/src/management/types.ts:142
Maximum TTL in ms for ephemeral rooms (-1 = unlimited).
maxPeersPerRoom
Section titled “maxPeersPerRoom”maxPeersPerRoom:
number|undefined
Defined in: packages/relay/src/management/types.ts:130
Hard cap on concurrent peers per room. -1 = unlimited.
maxRooms
Section titled “maxRooms”maxRooms:
number|undefined
Defined in: packages/relay/src/management/types.ts:127
Hard cap on distinct rooms within the project. -1 = unlimited.
maxTotalPeers
Section titled “maxTotalPeers”maxTotalPeers:
number|undefined
Defined in: packages/relay/src/management/types.ts:133
Hard cap on concurrent peers across all project rooms. -1 = unlimited.
maxTotalStateBytes
Section titled “maxTotalStateBytes”maxTotalStateBytes:
number|undefined
Defined in: packages/relay/src/management/types.ts:145
Maximum combined state size in bytes across all rooms (-1 = unlimited).
messageRateIntervalMs
Section titled “messageRateIntervalMs”messageRateIntervalMs:
number|undefined
Defined in: packages/relay/src/management/types.ts:139
Refill window for messageRateLimit in milliseconds.
messageRateLimit
Section titled “messageRateLimit”messageRateLimit:
number|undefined
Defined in: packages/relay/src/management/types.ts:136
Per-peer message rate limit (messages per messageRateIntervalMs).
projectId
Section titled “projectId”projectId:
string
Defined in: packages/relay/src/management/types.ts:124
The project this quota applies to.
updatedAt
Section titled “updatedAt”updatedAt:
number
Defined in: packages/relay/src/management/types.ts:148
Epoch milliseconds when the project’s quota was last adjusted.