Class: User

index.User

All user team related queries require userID API https://fantasy.premierleague.com/api/entry/3586135/

example

const user = new User(1)

Hierarchy

• User

Implements

• UserProperties

Constructors

constructor

+ new User(userId: number): User

Parameters:

Name	Type
userId	number

Returns: User

Defined in: models/user.ts:33

Properties

userId

• userId: number

Implementation of: UserProperties.userId

Defined in: models/user.ts:33

Methods

getActiveChips

▸ getActiveChips(gw?: number[]): Promise<ActiveChipsDelegate>

Returns an array containing the user’s active chip for each gw, or the active chip of the given gameweeks.

example

const chips = new User(1).getActiveChips()

Parameters:

Name	Type
gw?	number[]

Returns: Promise<ActiveChipsDelegate>

Defined in: models/user.ts:203

---

getAutomaticSubs

▸ getAutomaticSubs(gw?: number[]): Promise<AutomaticSubsDelegate>

Get Automatic Substitutions Returns an array containing the user’s active chip for each gameweek, or the active chip of the given gameweeks.

example

const team = new User(1).getAutomaticSubs()

Parameters:

Name	Type
gw?	number[]

Returns: Promise<AutomaticSubsDelegate>

Defined in: models/user.ts:266

---

getChipsHistory

▸ getChipsHistory(): Promise<ChipsHistoryDelegate[]>

Return user's chip history

example

const team = new User(1).getChipsHistory()

Returns: Promise<ChipsHistoryDelegate[]>

Defined in: models/user.ts:186

---

getCupMatches

▸ getCupMatches(gw?: number[]): Promise<CupMatchesDelegate>

Returns an object of all the user’s cup matches, or of the cup match in the given gameweeks (gameweek 17 and onwards).

example

const team = new User(1).getCupMatches()

Parameters:

Name	Type
gw?	number[]

Returns: Promise<CupMatchesDelegate>

Defined in: models/user.ts:344

---

getCupStatus

▸ getCupStatus(): Promise<CupStatusDelegate>

Returns the user’s cup status.

example

const cupStatus = new User(1).getCupStatus()

Returns: Promise<CupStatusDelegate>

Defined in: models/user.ts:322

---

getDetails

▸ getDetails(): Promise<UserDelegate[]>

Return user's team details

example

const team = new User(1).getDetails()

Returns: Promise<UserDelegate[]>

Defined in: models/user.ts:45

---

getPicks

▸ getPicks(gw?: number[]): Promise<PickHistoryDelegate>

Return user's team player picks history

example

const transfers = await new User(1).getPicks([1])

remark Will return picks for the requested GWs. If empty, will return for all GWs

Parameters:

Name	Type
gw?	number[]

Returns: Promise<PickHistoryDelegate>

Defined in: models/user.ts:134

---

getSeasonsHistory

▸ getSeasonsHistory(): Promise<SeasonsHistoryDelegate[]>

Return user's previous history

example

const team = new User(1).getChipsHistory()

Returns: Promise<SeasonsHistoryDelegate[]>

Defined in: models/user.ts:384

---

getTransfers

▸ getTransfers(gw?: number[]): Promise<TransferDelegate[]>

Return user's team transfer history

example

const transfers = await new User(1).getTransfers([1])

Parameters:

Name	Type
gw?	number[]

Returns: Promise<TransferDelegate[]>

Defined in: models/user.ts:97

---

gwHistory

▸ gwHistory(gw?: number[]): Promise<GWHistoryDelegate[]>

Returns array of requested Gameweek history, if not, returns all gw

example

const history = await new User(1).getTransfers([1, 2, 4])

Parameters:

Name	Type
gw?	number[]

Returns: Promise<GWHistoryDelegate[]>

Defined in: models/user.ts:62