Takaro - v0.7.2
    Preparing search index...

    Class TakaroEventRateLimited

    Generic Data Transfer Object, used widely in Takaro to pass data back and forth between components Allows validation of properties when instantiated and JSON (de)serialization

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    burstLimit droppedCount limitedEventType sampleMessage? sampleTimestamp? scope sustainedLimit timestamp type windowMs

    Methods

    toJSON validate

    Constructors

    Properties

    burstLimit: number
    droppedCount: number
    limitedEventType: string
    sampleMessage?: string
    sampleTimestamp?: string
    scope: "global" | "server" | "domain"
    sustainedLimit: number
    timestamp: string = ...
    type: "event-rate-limited" = TakaroEvents.EVENT_RATE_LIMITED
    windowMs: number

    Methods

    • Parameters

      • OptionaloptionOverrides: ClassTransformOptions

      Returns Record<string, any>

    • Validates the DTO instance

      Parameters

      • OptionalextraOpts: ValidatorOptions

      Returns Promise<void>

      if validation fails

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods