Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetTFTLeagueEntries

Hierarchy

  • (Anonymous class)<GetTFTLeagueEntriesQuery, (Anonymous class) & (Anonymous class) & (Anonymous class) & (Anonymous class) & Action, this> & (Anonymous class)<(Anonymous class) & (Anonymous class) & (Anonymous class) & Action, this> & (Anonymous class)<(Anonymous class) & (Anonymous class) & Action, this> & (Anonymous class)<(Anonymous class) & Action, this> & (Anonymous class)<LeagueRegion, Action, this> & Action<LeagueEntryDTO[], this>
    • GetTFTLeagueEntries

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

payload

payload: Payload

The payload containing the data (endpoint, request type, parameters, etc.) related to the associated Action. The type guards associated with setting certain properties of the payload are checked at runtime and may throw errors when provided invalid values.

Methods

URL

  • URL(): string
  • Returns the encoded target URL for the action without executing an HTTP request. Useful if the URL string is needed for custom actions outside the scope of the library.

    throws

    Will throw an error if a required payload value (region, body on POST or PUT requests, etc.) is missing.

    Returns string

division

  • division<K>(this: K, division: Division): Omit<K, "division">
  • Modifies the division associated with the Action object it is called from. Note that associated runtime type checks are performed to ensure that the provided division matches one of the expected queues for the corresponding game.

    throws

    Will throw an error if an invalid division is provided or the provided division fails the runtime type check.

    Type parameters

    Parameters

    • this: K
    • division: Division

      The division to update the calling Action object with.

    Returns Omit<K, "division">

exec

  • Executes the action, sending an HTTP request to the Riot API servers and retrieving the associated data from the appropriate endpoint.

    throws

    Will throw an error if a required payload value (region, body on POST or PUT requests, etc.) is missing or the HTTP request fails with an error.

    Returns Promise<LeagueEntryDTO[]>

query

  • query<K>(this: K, query: TQuery): Omit<K, "query">

region

  • region<K>(this: K, region: TRegion): Omit<K, "region">
  • Modifies the region associated with the Action object it is called from. Note that associated runtime type checks are performed to ensure that the provided region matches one of the expected API regions.

    throws

    Will throw an error if an invalid region is provided or the provided region fails the runtime type check.

    Type parameters

    Parameters

    • this: K
    • region: TRegion

      The region to update the calling Action object with.

    Returns Omit<K, "region">

set

  • Sets multiple values in the Action payload simultaneously.

    Parameters

    • payload: ModifiablePayload

      The payload with which the Action's payload is overwritten

    Returns this

    The current Action (with the updated payload state).

summonerId

  • summonerId<K>(this: K, summonerId: string): Omit<K, "summonerId">
  • Modifies the summonerId associated with the Action object it is called from. Note that associated runtime type checks are performed to ensure that the summoner ID conforms to Riot specifications.

    throws

    Will throw an error if an invalid summonerId is provided.

    Type parameters

    Parameters

    • this: K
    • summonerId: string

      The summoner ID to update the calling Action object with.

    Returns Omit<K, "summonerId">

tier

  • tier<K>(this: K, tier: Tier): Omit<K, "tier">
  • Modifies the tier associated with the Action object it is called from. Note that associated runtime type checks are performed to ensure that the provided tier matches one of the expected queues for the corresponding game.

    throws

    Will throw an error if an invalid tier is provided or the provided tier fails the runtime type check.

    Type parameters

    Parameters

    • this: K
    • tier: Tier

      The tier to update the calling Action object with.

    Returns Omit<K, "tier">