@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
GitHub
NPM
Preparing search index...
src/core/rateLimiter/IRateLimiter
IRateLimiter
Interface IRateLimiter
interface
IRateLimiter
{
checkRateLimit
(
templatePath
?:
string
,
method
?:
string
,
requestHeaders
?:
Record
<
string
,
string
>
,
)
:
Promise
<
void
>
;
updateFromResponse
(
headers
:
Record
<
string
,
string
>
,
statusCode
:
number
,
templatePath
?:
string
,
method
?:
string
,
requestHeaders
?:
Record
<
string
,
string
>
,
)
:
void
;
getStatus
()
:
{
remaining
:
number
;
limit
:
number
;
used
:
number
;
group
:
string
|
null
;
errorLimitRemain
:
number
;
errorLimitReset
:
number
;
retryAfter
:
number
|
null
;
blockedUntil
:
number
;
}
;
getGroupStatus
(
group
:
string
)
:
RateLimitGroupStatus
|
undefined
;
getAllGroupStatuses
()
:
Map
<
string
,
RateLimitGroupStatus
>
;
isBlocked
(
group
?:
string
)
:
boolean
;
reset
()
:
void
;
}
Implemented by
RateLimiter
Index
Methods
check
Rate
Limit
update
From
Response
get
Status
get
Group
Status
get
All
Group
Statuses
is
Blocked
reset
Methods
check
Rate
Limit
checkRateLimit
(
templatePath
?:
string
,
method
?:
string
,
requestHeaders
?:
Record
<
string
,
string
>
,
)
:
Promise
<
void
>
Parameters
Optional
templatePath
:
string
Optional
method
:
string
Optional
requestHeaders
:
Record
<
string
,
string
>
Returns
Promise
<
void
>
update
From
Response
updateFromResponse
(
headers
:
Record
<
string
,
string
>
,
statusCode
:
number
,
templatePath
?:
string
,
method
?:
string
,
requestHeaders
?:
Record
<
string
,
string
>
,
)
:
void
Parameters
headers
:
Record
<
string
,
string
>
statusCode
:
number
Optional
templatePath
:
string
Optional
method
:
string
Optional
requestHeaders
:
Record
<
string
,
string
>
Returns
void
get
Status
getStatus
()
:
{
remaining
:
number
;
limit
:
number
;
used
:
number
;
group
:
string
|
null
;
errorLimitRemain
:
number
;
errorLimitReset
:
number
;
retryAfter
:
number
|
null
;
blockedUntil
:
number
;
}
Returns
{
remaining
:
number
;
limit
:
number
;
used
:
number
;
group
:
string
|
null
;
errorLimitRemain
:
number
;
errorLimitReset
:
number
;
retryAfter
:
number
|
null
;
blockedUntil
:
number
;
}
get
Group
Status
getGroupStatus
(
group
:
string
)
:
RateLimitGroupStatus
|
undefined
Parameters
group
:
string
Returns
RateLimitGroupStatus
|
undefined
get
All
Group
Statuses
getAllGroupStatuses
()
:
Map
<
string
,
RateLimitGroupStatus
>
Returns
Map
<
string
,
RateLimitGroupStatus
>
is
Blocked
isBlocked
(
group
?:
string
)
:
boolean
Parameters
Optional
group
:
string
Returns
boolean
reset
reset
()
:
void
Returns
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
check
Rate
Limit
update
From
Response
get
Status
get
Group
Status
get
All
Group
Statuses
is
Blocked
reset
ESI Documentation
EVE Online
GitHub
NPM
@lgriffin/esi.ts - EVE Online ESI API Client - v12.3.0
Loading...