Search
Preparing search index...
The search index is not available
battlerite.js
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"request"
External module "request"
Index
Classes
APIError
Interfaces
IAPIRequest
Params
IData
IResponse
Data
Type aliases
APIMethod
Variables
rate
Limit
Wait
root
Functions
api
Request
api
Request
Paged
raw
Request
reset
Time
InMs
sleep
Type aliases
APIMethod
APIMethod
:
"POST"
|
"GET"
Variables
rate
Limit
Wait
rate
Limit
Wait
:
Promise
<
any
>
= Promise.resolve()
root
root
:
"https://api.dc01.gamelockerapp.com/shards/global"
= "https://api.dc01.gamelockerapp.com/shards/global"
Functions
api
Request
api
Request
(
token
:
string
, method
:
APIMethod
, endpoint
:
string
, params
?:
IAPIRequestParams
)
:
Promise
<
IResponseData
>
Parameters
token:
string
method:
APIMethod
endpoint:
string
Default value
params:
IAPIRequestParams
= {}
Returns
Promise
<
IResponseData
>
api
Request
Paged
api
Request
Paged
(
token
:
string
, method
:
APIMethod
, endpoint
:
string
, params
:
IAPIRequestParams
, amount
:
number
)
:
Promise
<
IResponseData
>
Parameters
token:
string
method:
APIMethod
endpoint:
string
params:
IAPIRequestParams
amount:
number
Returns
Promise
<
IResponseData
>
raw
Request
raw
Request
(
method
:
any
, url
:
any
, opts
?:
object
)
:
Promise
<
any
>
Parameters
method:
any
url:
any
Default value
opts:
object
= {}
Returns
Promise
<
any
>
reset
Time
InMs
reset
Time
InMs
(
resetTime
:
any
)
:
number
Parameters
resetTime:
any
Returns
number
sleep
sleep
(
ms
:
any
)
:
Promise
<
Object
>
Parameters
ms:
any
Returns
Promise
<
Object
>
Globals
"client"
"data/champions"
"data/maps"
"entities/
Asset"
"entities/
Entity"
"entities/
Match"
"entities/
Participant"
"entities/
Player"
"entities/
Roster"
"entities/
Round"
"entity
Mapper"
"index"
"request"
"utils"
APIError
IAPIRequest
Params
IData
IResponse
Data
APIMethod
rate
Limit
Wait
root
api
Request
api
Request
Paged
raw
Request
reset
Time
InMs
sleep
Generated using
TypeDoc