Class IpBearerThrottlerGuard

Rate-limiting guard that keys each throttle bucket on the combination of the client IP address and Bearer token.

Using both dimensions means:

Different IPs with the same token are counted separately (IP-level limit).
The same IP using different tokens is also counted separately (token-level limit).

If no token is present the key degrades gracefully to <ip>: so that unauthenticated probing is also throttled.

Hierarchy

ThrottlerGuard
- IpBearerThrottlerGuard

Index

Constructors

constructor

new IpBearerThrottlerGuard(
    options: ThrottlerModuleOptions,
    storageService: ThrottlerStorage,
    reflector: Reflector,
): IpBearerThrottlerGuard
Parameters
- options: ThrottlerModuleOptions
- storageService: ThrottlerStorage
- reflector: Reflector
Returns IpBearerThrottlerGuard
Inherited from _ThrottlerGuard.constructor
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:14

Properties

`Protected`commonOptions

commonOptions: Pick<
    ThrottlerOptions,
    "skipIf"
    | "ignoreUserAgents"
    | "getTracker"
    | "generateKey"
    | "setHeaders",
>

`Protected`errorMessage

errorMessage: string

`Protected`headerPrefix

headerPrefix: string

`Protected` `Readonly`options

options: ThrottlerModuleOptions

`Protected` `Readonly`reflector

reflector: Reflector

`Protected` `Readonly`storageService

storageService: ThrottlerStorage

`Protected`throttlers

throttlers: ThrottlerOptions[]

Methods

canActivate

canActivate(context: ExecutionContext): Promise<boolean>
Parameters
- context: ExecutionContext
  Current execution context. Provides access to details about the current request pipeline.
Returns Promise<boolean>
Value indicating whether or not the current request is allowed to proceed.
Inherited from _ThrottlerGuard.canActivate
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:16

`Protected`generateKey

generateKey(context: ExecutionContext, suffix: string, name: string): string
Parameters
- context: ExecutionContext
- suffix: string
- name: string
Returns string
Inherited from _ThrottlerGuard.generateKey
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:24

`Protected`getErrorMessage

getErrorMessage(
context: ExecutionContext,
throttlerLimitDetail: ThrottlerLimitDetail,
): Promise<string>
Parameters
- context: ExecutionContext
- throttlerLimitDetail: ThrottlerLimitDetail
Returns Promise<string>
Inherited from _ThrottlerGuard.getErrorMessage
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:26

`Protected`getRequestResponse

getRequestResponse(
context: ExecutionContext,
): { req: Record<string, any>; res: Record<string, any> }
Parameters
- context: ExecutionContext
Returns { req: Record<string, any>; res: Record<string, any> }
Inherited from _ThrottlerGuard.getRequestResponse
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:20

`Protected`getTracker

getTracker(request: Request): Promise<string>
Builds the throttle storage key for the incoming request.
Parameters
- request: Request
  The raw Express request object.
Returns Promise<string>
A string key of the form <ip>:<token>.
Overrides _ThrottlerGuard.getTracker
- Defined in src/common/throttler/throttler.guard.ts:27

`Protected`handleRequest

handleRequest(requestProps: ThrottlerRequest): Promise<boolean>
Parameters
- requestProps: ThrottlerRequest
Returns Promise<boolean>
Inherited from _ThrottlerGuard.handleRequest
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:18

onModuleInit

onModuleInit(): Promise<void>
Returns Promise<void>
Inherited from _ThrottlerGuard.onModuleInit
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:15

`Protected`shouldSkip

shouldSkip(_context: ExecutionContext): Promise<boolean>
Parameters
- _context: ExecutionContext
Returns Promise<boolean>
Inherited from _ThrottlerGuard.shouldSkip
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:17

`Protected`throwThrottlingException

throwThrottlingException(
context: ExecutionContext,
throttlerLimitDetail: ThrottlerLimitDetail,
): Promise<void>
Parameters
- context: ExecutionContext
- throttlerLimitDetail: ThrottlerLimitDetail
Returns Promise<void>
Inherited from _ThrottlerGuard.throwThrottlingException
- Defined in node_modules/@nestjs/throttler/dist/throttler.guard.d.ts:25

Class IpBearerThrottlerGuard

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IpBearerThrottlerGuard

Properties

ProtectedcommonOptions

ProtectederrorMessage

ProtectedheaderPrefix

Protected Readonlyoptions

Protected Readonlyreflector

Protected ReadonlystorageService

Protectedthrottlers

Methods

canActivate

Parameters

Returns Promise<boolean>

ProtectedgenerateKey

Parameters

Returns string

ProtectedgetErrorMessage

Parameters

Returns Promise<string>

ProtectedgetRequestResponse

Parameters

Returns { req: Record<string, any>; res: Record<string, any> }

ProtectedgetTracker

Parameters

Returns Promise<string>

ProtectedhandleRequest

Parameters

Returns Promise<boolean>

onModuleInit

Returns Promise<void>

ProtectedshouldSkip

Parameters

Returns Promise<boolean>

ProtectedthrowThrottlingException

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`commonOptions

`Protected`errorMessage

`Protected`headerPrefix

`Protected` `Readonly`options

`Protected` `Readonly`reflector

`Protected` `Readonly`storageService

`Protected`throttlers

`Protected`generateKey

`Protected`getErrorMessage

`Protected`getRequestResponse

`Protected`getTracker

`Protected`handleRequest

`Protected`shouldSkip

`Protected`throwThrottlingException