ThunderAPI - Documentation

Constructor

new ThunderAPI(optionsopt)

Source:

index.js, line 9

Creates a new instance of ThunderAPI

Parameters:

Name	Type	Attributes	Default	Description
`options`	ThunderAPIOptions	<optional>	`{}`	The timeout in milliseconds to sweep the cache, defaults to 180000 milliseconds

Members

(private) _intervals :Set.<Timeout>

Source:

index.js, line 64

Intervals set by ThunderAPI#setInterval that are still active

Type:

Set.<Timeout>

(private) _timeouts :Set.<Timeout>

Source:

index.js, line 57

Timeouts set by ThunderAPI#setTimeout that are still active

Type:

Set.<Timeout>

(readonly) cacheSweepInterval :number

Source:

index.js, line 44

The time cache should be sweeped, in milliseconds

Type:

number

clans :Collection.<string, Clan>

Source:

index.js, line 37

A collection of cached squadrons. The collection will be sweeped after the time passed

Type:

Collection.<string, Clan>

(nullable) lastNews :Array.<NewsInfo>

Source:

index.js, line 50

The cached array of news items

Type:

Array.<NewsInfo>

(private) rest :RequestHandler

Source:

index.js, line 23

The Request Handler for ThunderApi

Type:

RequestHandler

users :Collection.<string, Profile>

Source:

index.js, line 30

A collection of cached profiles. The collection will be sweeped after the time passed

Type:

Collection.<string, Profile>

Methods

clearInterval(interval)

Source:

index.js, line 221

Clears an interval.

Parameters:

Name	Type	Description
`interval`	Timeout	Interval to cancel

clearTimeout(timeout)

Source:

index.js, line 199

Clears a timeout.

Parameters:

Name	Type	Description
`timeout`	Timeout	Timeout to cancel

destroy()

Source:

index.js, line 172

Destroys all assets used by ThunderAPI.

fetchClan(name, cacheopt) → {Promise.<Clan>}

Source:

index.js, line 138

Get's info about a squadron.

You must provide the full name of the squadron, e.g. "35th Gopnik nation battle group" instead of "GOPNK".

Example

// The following example gets info about
// the squadron 35th Gopnik nation battle group,
// and logs the squadron description, and the
// date this squadron was created
ThunderAPI.getSquadron("35th Gopnik nation battle group")
  .then(data => {
    console.log(data.description);
    console.log(data.createdAt);
  })
  .catch(err => console.error("Oh no, an error occurred!", err));

Parameters:

Name	Type	Attributes	Default	Description
`name`	string			The full name of the squadron
`cache`	boolean	<optional>	`true`	If it should get the squadron from the cache, if cached. Defaults to true

Returns:

Type: Promise.<Clan>

fetchUser(player, cacheopt) → {Promise.<User>}

Source:

index.js, line 86

Get a player's profile

Example

// The following example gets the profile of the player
// TheDutchy0412 and logs the squadron name
// and the registration date
ThunderAPI.getPlayer("TheDutchy0412")
  .then(profile => {
    console.log(profile.squadron);
    console.log(profile.registered);
  })
  .catch(err => console.error("Oh no, an error occurred!", err));

Parameters:

Name	Type	Attributes	Default	Description
`player`	string			The profile of the player to fetch
`cache`	boolean	<optional>	`true`	If it should get the player from the cache. Defaults to true

Returns:

Type: Promise.<User>

getNews(cacheopt) → {Promise.<Array.<NewsInfo>>}

Source:

index.js, line 147

Returns an array of news objects

Parameters:

Name	Type	Attributes	Default	Description
`cache`	boolean	<optional>	`true`	If it should return the cached news object. Defaults to true

Returns:

Type: Promise.<Array.<NewsInfo>>

isUser(player) → {Promise.<boolean>}

Source:

index.js, line 110

Verifies the given player's in-game nickname

Parameters:

Name	Type	Description
`player`	string	The player to verify

Returns:

Type: Promise.<boolean>

searchWiki(query) → {Promise.<Array.<Wiki>>}

Source:

index.js, line 95

Searches on the War Thunder wiki

Parameters:

Name	Type	Description
`query`	string	The query to search on

Returns:

Type: Promise.<Array.<Wiki>>

setInterval(fn, delay, …args) → {Timeout}

Source:

index.js, line 211

Sets an interval that will be automatically cancelled if the client is destroyed.

Parameters:

Name	Type	Attributes	Description
`fn`	function		Function to execute
`delay`	number		Time to wait between executions (in milliseconds)
`args`	*	<repeatable>	Arguments for the function

Returns:

Type: Timeout

setTimeout(fn, delay, …args) → {Timeout}

Source:

index.js, line 186

Sets a timeout that will be automatically cancelled if the instance of ThunderAPI is destroyed.

Parameters:

Name	Type	Attributes	Description
`fn`	function		Function to execute
`delay`	number		Time to wait before executing (in milliseconds)
`args`	*	<repeatable>	Arguments for the function

Returns:

Type: Timeout

sweepCache() → {boolean}

Source:

index.js, line 159

Sweeps the cache

Returns:

If the cache sweep was successful

Type: boolean