Type Alias IRateLimiterPolicy<TMetrics>

Type declaration

• getAttempts:function

  • getAttempts(currentMetrics: TMetrics, currentDate: Date): number

  • The getAttempts method returns amount of used attempts.

    Parameters

    • currentMetrics: TMetrics
    • currentDate: Date

    Returns number

• getExpiration:function

  • getExpiration(currentMetrics: TMetrics, currentDate: Date): Date

  • The getExpiration method should return the expiration as Date. This method is optional, if defined rate limiter data will be cleaned up when expired. If not defined the rate limiter data will be stored forever.

    Parameters

    • currentMetrics: TMetrics
    • currentDate: Date

    Returns Date

• initialMetrics:function

  • initialMetrics(currentDate: Date): TMetrics

  • Parameters

    • currentDate: Date

    Returns TMetrics

• shouldBlock:function

  • shouldBlock(currentMetrics: TMetrics, limit: number, currentDate: Date): boolean

  • Parameters

    • currentMetrics: TMetrics
    • limit: number
    • currentDate: Date

    Returns boolean

• updateMetrics:function

  • updateMetrics(currentMetrics: TMetrics, currentDate: Date): TMetrics

  • The updateMetrics method updates the metrics when an attempt occurs.

    Parameters

    • currentMetrics: TMetrics
    • currentDate: Date

    Returns TMetrics