Class: Player#

index.Player

API: https://fantasy.premierleague.com/api/bootstrap-static/

example

const player = new Player(1)

Hierarchy#

  • Player

Constructors#

constructor#

+ new Player(playersId: number[]): Player

Parameters:#

NameType
playersIdnumber[]

Returns: Player

Defined in: models/player.ts:17

Properties#

playersId#

• playersId: number[]

Defined in: models/player.ts:17

Methods#

getDetails#

â–¸ getDetails(includeStats?: boolean, includeSummary?: boolean): Promise<PlayerDelegate[]>

Returns array of requested players. If none, it returns all players

remark stats from https://www.reddit.com/r/FantasyPL/comments/6r60fu/exploring_a_key_metric_value_added_per_1m/

remark set includeSummary to true to return player profile with summary

remark Return player details with stats

example

const player = await new Player([302]).getDetails(true, false)

remark Return player details with summary

example

const player = await new Player([302]).getDetails(false, true)

Parameters:#

NameType
includeStats?boolean
includeSummary?boolean

Returns: Promise<PlayerDelegate[]>

PlayerDelegate[]

Defined in: models/player.ts:74


getSummary#

â–¸ getSummary(): Promise<PlayerSummaryDelegate[]>

Returns array of requested players summary. If none, it returns all players summary

example

const player = await new Player([302]).getSummary()

Returns: Promise<PlayerSummaryDelegate[]>

PlayerSummaryDelegate[]

Defined in: models/player.ts:33