Class: RateLimitManager<K>
ratelimits/src.RateLimitManager
Type parameters
Name | Type |
---|---|
K | string |
Hierarchy
Map
<K
,RateLimit
<K
>>↳
RateLimitManager
Constructors
constructor
• new RateLimitManager<K
>(time
, limit?
)
Type parameters
Name | Type |
---|---|
K | string |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
time | number | undefined | |
limit | number | 1 |
Overrides
Map<K, RateLimit<K\>\>.constructor
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:24
Properties
[toStringTag]
• Readonly
[toStringTag]: string
Inherited from
Map.__@toStringTag@154381
Defined in
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:135
limit
• Readonly
limit: number
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:13
size
• Readonly
size: number
Inherited from
Map.size
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:48
sweepInterval
• Private
sweepInterval: null
| Timer
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:18
time
• Readonly
time: number
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:8
[species]
▪ Static
Readonly
[species]: MapConstructor
Inherited from
Map.__@species@156157
Defined in
node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:317
sweepIntervalDuration
▪ Static
sweepIntervalDuration: number
= 30_000
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:76
Methods
[iterator]
▸ [iterator](): IterableIterator
<[K
, RateLimit
<K
>]>
Returns
IterableIterator
<[K
, RateLimit
<K
>]>
Inherited from
Map.__@iterator@154190
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:121
acquire
▸ acquire(id
): RateLimit
<K
>
Parameters
Name | Type | Description |
---|---|---|
id | K |
Returns
RateLimit
<K
>
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:35
clear
▸ clear(): void
Returns
void
Inherited from
Map.clear
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:23
create
▸ create(id
): RateLimit
<K
>
Parameters
Name | Type | Description |
---|---|---|
id | K |
Returns
RateLimit
<K
>
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:43
delete
▸ delete(key
): boolean
Parameters
Name | Type |
---|---|
key | K |
Returns
boolean
Inherited from
Map.delete
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:27
entries
▸ entries(): IterableIterator
<[K
, RateLimit
<K
>]>
Returns
IterableIterator
<[K
, RateLimit
<K
>]>
Inherited from
Map.entries
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:126
forEach
▸ forEach(callbackfn
, thisArg?
): void
Parameters
Name | Type |
---|---|
callbackfn | (value : RateLimit <K >, key : K , map : Map <K , RateLimit <K >>) => void |
thisArg? | any |
Returns
void
Inherited from
Map.forEach
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:31
get
▸ get(key
): undefined
| RateLimit
<K
>
Parameters
Name | Type |
---|---|
key | K |
Returns
undefined
| RateLimit
<K
>
Inherited from
Map.get
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:36
has
▸ has(key
): boolean
Parameters
Name | Type |
---|---|
key | K |
Returns
boolean
Inherited from
Map.has
Defined in
node_modules/typescript/lib/lib.es2015.collection.d.ts:40
keys
▸ keys(): IterableIterator
<K
>
Returns
IterableIterator
<K
>
Inherited from
Map.keys
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:131
set
▸ set(id
, value
): RateLimitManager
<K
>
Parameters
Name | Type | Description |
---|---|---|
id | K | |
value | RateLimit <K > |
Returns
Overrides
Map.set
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:54
sweep
▸ sweep(): void
Returns
void
Defined in
projects/utilities/packages/ratelimits/src/lib/RateLimitManager.ts:62
values
▸ values(): IterableIterator
<RateLimit
<K
>>
Returns
IterableIterator
<RateLimit
<K
>>
Inherited from
Map.values
Defined in
node_modules/typescript/lib/lib.es2015.iterable.d.ts:136