Api References NestJS

ThrottlerLimitDetail

interface

Interface describing the details of a rate limit applied by the ThrottlerGuard.


interface ThrottlerLimitDetail extends ThrottlerStorageRecord {
  ttl: number
  limit: number
  key: string
  tracker: string
}

Property	Description
`ttl: number`	Time to live for the rate limit, in seconds. After this time has elapsed, the rate limit is removed.
`limit: number`	Maximum number of requests allowed within the time period defined by `ttl`.
`key: string`	Unique identifier for the rate limit. This field is used to group requests that share the same rate limit.
`tracker: string`	A string representation of the tracker object used to keep track of the incoming requests and apply the rate limit.