DOCSEARCHbyAlgolia
Submit Docs

Shieldbow API Reference

website·Indexed 31 days ago

https://shieldbow.thedrone7.dev/

API documentation for Shieldbow, featuring types, interfaces, and functions for interacting with League of Legends data, including champion mastery, summoner methods, clash, and regional API configurations.

Tokens
45.2K
Snippets
338
Records
495
Agent score
53%

What's inside Shieldbow

  1. Use the TurretPlateDestroyedEventData interface

    The TurretPlateDestroyedEventData interface provides detailed information about a turret plate destruction event. It extends TimelineEventData and includes specific properties to identify the killer, the location, and the team involved.
    export interface TurretPlateDestroyedEventData extends TimelineEventData {
  killerId: number;
  laneType: string;
  position: PositionData;
  teamId: 100 | 200;
  type: 'TURRET_PLATE_DESTROYED';
}

  2. Implement a storage plugin using the IStorage interface

    The IStorage interface serves as the base contract for creating storage plugins. It defines a standard set of methods for persisting, retrieving, deleting, and searching for data across different collections identified by a key.
    export interface IStorage

  3. Configure automatic rate limiting in Shieldbow

    The Shieldbow v2 client handles rate limiting automatically by processing response headers and storing limit information in memory. This allows the client to function correctly in distributed environments even without a shared cache. If implementing a custom caching solution, rate limit keys are identified by the prefix limits: and contain an array of numbers as their value.

  5. Use the WardKillEvent class to represent ward kill events

    The WardKillEvent class is used to represent an event where a ward was killed. It extends the TimelineEvent class. It contains information about the participant who destroyed the ward and the specific type of ward that was killed.
    export declare class WardKillEvent extends TimelineEvent

  7. Access summoner challenge data via SummonerChallenge properties

    The SummonerChallenge class provides the following properties to retrieve challenge-related information for a summoner:

    • categoryPoints: A Collection mapping CategoryName to ChallengeCategory, providing an overview of challenge categories.
    • challenges: A Collection mapping challenge IDs (Number) to ChallengeProgression objects, containing individual progression stats.
    • preferences: An instance of ChallengePreferences containing the summoner's settings.
    • totalPoints: An instance of TotalChallengePoints providing a high-level overview of the summoner's total points.

  8. Use the WardPlacedEventData interface for ward placement events

    The WardPlacedEventData interface extends TimelineEventData and provides specific details about a ward placement event. It contains the ID of the creator, the event type identifier, and the specific type of ward placed.
    export interface WardPlacedEventData extends TimelineEventData {
  creatorId: number;
  type: 'WARD_PLACED';
  wardType: string;
}

  9. Use the EliteMonsterKillEvent class to track elite monster kills

    The EliteMonsterKillEvent class (which extends TimelineEvent) represents the event of an elite monster being killed. It provides detailed information about the monster's type and subtype, the killing participant and team, assisting players, the bounty earned, and the location of the kill.
    // Example instantiation
const event = new EliteMonsterKillEvent(data);

  10. Use the BuildingKillEvent class to represent building destruction

    The BuildingKillEvent class extends TimelineEvent and is used to represent the event of a building being destroyed. It provides detailed information about the killer, the team, the building type, and the location of the event.
    export declare class BuildingKillEvent extends TimelineEvent

  11. Use the ChampionBan interface to represent banned champions

    The ChampionBan interface represents a champion that has been banned during a match. It provides details about which champion was banned and the sequence in which the ban occurred.
    export interface ChampionBan {
  champion: Champion;
  order: number;
}

  12. Use the DragonSoulGivenEventData interface for dragon soul events

    The DragonSoulGivenEventData interface represents the event data triggered when a dragon soul is given. It extends TimelineEventData and contains specific details about the type of soul and the team that received it.
    export interface DragonSoulGivenEventData extends TimelineEventData {
  name: 'Mountain' | 'Ocean' | 'Infernal' | 'Hextech' | 'Cloud';
  teamId: 100 | 200;
  type: 'DRAGON_SOUL_GIVEN';
}