-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.d.ts
89 lines (79 loc) · 2.67 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/**
* A TeamColor object contains a hexadecimal
* color with it's rgb representation as an
* array of RGB values
*/
export interface TeamColor {
hex: string;
rgb: [number, number, number];
}
/**
* A TeamColors object is a list of
* TeamColors, each containing a hexadecimal
* string and an array of RGB values
*/
export interface TeamColors {
[colorName: string]: TeamColor;
}
/**
* A Color object contain's an Overwatch League
* team's full name, primaryColor, and a list
* of associated hex colors
*/
export interface Colors {
[abbreviatedName: string]: {
fullName: string;
primaryColor: string;
colors: TeamColors;
};
}
/**
* Returns all Overwatch League Colors
* @returns {Colors} returns an Object containing all
* Overwatch League teams color data.
*/
export function getAllColors(): Colors;
/**
* Returns a team's primary color
* @param {string} abbreviatedName an Overwatch League team
* abbreviation (lowercase or uppercase)
* @returns {TeamColor} An object containing the team's
* primary color's Hexadecimal color code and RGB color code.
*/
export function getPrimaryColor(abbreviatedName: string): TeamColor;
/**
* Returns a team's secondary color
* @param {string} abbreviatedName an Overwatch League team
* abbreviation (lowercase or uppercase)
* @returns {TeamColor} An object containing the team's
* secondary color's Hexadecimal color code and RGB color code.
*/
export function getSecondaryColor(abbreviatedName: string): TeamColor;
/**
* Returns a team's tertiary color
* @param {string} abbreviatedName an Overwatch League team
* abbreviation (lowercase or uppercase)
* @returns {TeamColor} An object containing the team's
* tertiary color's Hexadecimal color code and RGB color code.
*/
export function getTertiaryColor(abbreviatedName: string): TeamColor;
/**
* Returns all colors for a specific Overwatch League Team
* @param {string} abbreviatedName Overwatch League team abbreviation
* @returns {TeamColors} a list of hexadecimal color code and RGB color code
* for the specified team.
*/
export function getColors(abbreviatedName: string): TeamColors;
/**
* Returns the full team name of a specified
* Overwatch League Team
* @param {string} abbreviatedName Overwatch League team abbreviation
* @returns {string} an Overwatch League team name
*/
export function getTeamName(abbreviatedName: string): string;
/**
* Returns the color list for the specified team
* @param {string} abbreviatedName Overwatch League team abbreviation
* @returns {string[]} an array of Overwatch League team colors.
*/
export function getColorList(abbreviatedName: string): string[];