Class Client

Hierarchy

Client

Index

Constructors

constructor

new Client(token: string, options?: ClientOptions): Client
Parameters
- token: string
- options: ClientOptions = ...
Returns Client
- Defined in src/Client.ts:30

Properties

baseURL

baseURL: string = "https://api.brawlstars.com/v1"

`Optional` cache

cache?: NodeCache

token

token: string

Accessors

authorization

get authorization(): string
Returns the bearer value for authorization header.

Returns

Returns string
- Defined in src/Client.ts:39

Methods

`Private` _fetch

_fetch<T>(path: string, query?: any): Promise<T>
Type Parameters
- T
Parameters
- path: string
- Optional query: any
Returns Promise<T>
- Defined in src/Client.ts:43

getBrawler

getBrawler(id: string): Promise<Brawler>
Parameters
- id: string
Returns Promise<Brawler>
- Defined in src/Client.ts:157

getBrawlerRankings

getBrawlerRankings(country: string, brawler: string, __namedParameters?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<RankingsPlayer[]>
Parameters
- country: string
- brawler: string
- __namedParameters: {
      after?: string;
      before?: string;
      limit?: number;
  } = {}
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<RankingsPlayer[]>
- Defined in src/Client.ts:107

getBrawlers

getBrawlers(__namedParameters?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<Brawler[]>
Parameters
- __namedParameters: {
      after?: string;
      before?: string;
      limit?: number;
  } = {}
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<Brawler[]>
- Defined in src/Client.ts:147

getClub

getClub(tag: string): Promise<Club>
Parameters
- tag: string
Returns Promise<Club>
- Defined in src/Client.ts:83

getClubMembers

getClubMembers(tag: string, __namedParameters?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<ClubMember[]>
Parameters
- tag: string
- __namedParameters: {
      after?: string;
      before?: string;
      limit?: number;
  } = {}
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<ClubMember[]>
- Defined in src/Client.ts:137

getClubRankings

getClubRankings(country: string, __namedParameters?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<RankingsClub[]>
Parameters
- country: string
- __namedParameters: {
      after?: string;
      before?: string;
      limit?: number;
  } = {}
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<RankingsClub[]>
- Defined in src/Client.ts:97

getEvents

getEvents(): Promise<ScheduledEvent[]>
Returns Promise<ScheduledEvent[]>
- Defined in src/Client.ts:161

getPlayer

getPlayer(tag: string): Promise<Player>
Parameters
- tag: string
Returns Promise<Player>
- Defined in src/Client.ts:70

getPlayerBattlelog

getPlayerBattlelog(tag: string): Promise<PlayerBattlelog[]>
Parameters
- tag: string
Returns Promise<PlayerBattlelog[]>
- Defined in src/Client.ts:79

getPlayerRankings

getPlayerRankings(country: string, __namedParameters?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<RankingsPlayer[]>
Parameters
- country: string
- __namedParameters: {
      after?: string;
      before?: string;
      limit?: number;
  } = {}
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<RankingsPlayer[]>
- Defined in src/Client.ts:87

getPowerPlayRankings

getPowerPlayRankings(country: string, seasonId: string, __namedParameters?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<RankingsPlayer[]>
Parameters
- country: string
- seasonId: string
- __namedParameters: {
      after?: string;
      before?: string;
      limit?: number;
  } = {}
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<RankingsPlayer[]>
- Defined in src/Client.ts:117

getPowerPlaySeasons

getPowerPlaySeasons(country: string, __namedParameters?: {
    after?: string;
    before?: string;
    limit?: number;
}): Promise<PowerPlaySeason[]>
Parameters
- country: string
- __namedParameters: {
      after?: string;
      before?: string;
      limit?: number;
  } = {}
  - Optional after?: string
  - Optional before?: string
  - Optional limit?: number
Returns Promise<PowerPlaySeason[]>
- Defined in src/Client.ts:127

Class Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

token: string

options: ClientOptions = ...

Returns Client

Properties

baseURL

Optional cache

token

Accessors

authorization

Returns

Returns string

Methods

Private _fetch

Type Parameters

T

Parameters

path: string

Optional query: any

Returns Promise<T>

getBrawler

Parameters

id: string

Returns Promise<Brawler>

getBrawlerRankings

Parameters

country: string

brawler: string

__namedParameters: { after?: string; before?: string; limit?: number; } = {}

Optional after?: string

Optional before?: string

Optional limit?: number

Returns Promise<RankingsPlayer[]>

getBrawlers

Parameters

__namedParameters: { after?: string; before?: string; limit?: number; } = {}

Optional after?: string

Optional before?: string

Optional limit?: number

Returns Promise<Brawler[]>

getClub

Parameters

tag: string

Returns Promise<Club>

getClubMembers

Parameters

tag: string

__namedParameters: { after?: string; before?: string; limit?: number; } = {}

Optional after?: string

Optional before?: string

Optional limit?: number

Returns Promise<ClubMember[]>

getClubRankings

Parameters

country: string

__namedParameters: { after?: string; before?: string; limit?: number; } = {}

Optional after?: string

Optional before?: string

Optional limit?: number

Returns Promise<RankingsClub[]>

getEvents

Returns Promise<ScheduledEvent[]>

getPlayer

Parameters

tag: string

Returns Promise<Player>

getPlayerBattlelog

Parameters

tag: string

Returns Promise<PlayerBattlelog[]>

getPlayerRankings

`Optional` cache

`Private` _fetch

`Optional` query: any

__namedParameters: {
after?: string;
before?: string;
limit?: number;
} = {}

`Optional` after?: string

`Optional` before?: string

`Optional` limit?: number

__namedParameters: {
after?: string;
before?: string;
limit?: number;
} = {}

`Optional` after?: string

`Optional` before?: string

`Optional` limit?: number

__namedParameters: {
after?: string;
before?: string;
limit?: number;
} = {}

`Optional` after?: string

`Optional` before?: string

`Optional` limit?: number

__namedParameters: {
after?: string;
before?: string;
limit?: number;
} = {}

`Optional` after?: string

`Optional` before?: string

`Optional` limit?: number

__namedParameters: {
after?: string;
before?: string;
limit?: number;
} = {}

`Optional` after?: string

`Optional` before?: string

`Optional` limit?: number

__namedParameters: {
after?: string;
before?: string;
limit?: number;
} = {}

`Optional` after?: string

`Optional` before?: string

`Optional` limit?: number

__namedParameters: {
after?: string;
before?: string;
limit?: number;
} = {}

`Optional` after?: string

`Optional` before?: string

`Optional` limit?: number