Skip to main content
Version: 3.19.0

PenaltyBox()

The PenaltyBox constructor can be used with a Edge Rate Limiter or standalone for adding and checking if some entry is in the dataset.

Note: Can only be used when processing requests, not during build-time initialization.

Syntax

new PenaltyBox(name)

Note: PenaltyBox() can only be constructed with new. Attempting to call it without new throws a TypeError.

Parameters

  • name : string
    • Open a PenaltyBox with the given name

Return value

A new PenaltyBox object instance.

Exceptions

  • TypeError
    • Thrown if the provided name value can not be coerced into a string