Class ZZZRecordModuleInternal

HSRRecordModule class provides methods to interact with Honkai Star Rail record module endpoints.

Constructors

constructor

Methods

abyss characters getCharacterAvatar hollowZero note records shiyuDefense

Constructors

constructor

Methods

abyss

  • abyss(abyssType?): Promise<ZZZAbyss>

  • Retrieves information about the player's performance in the specified abyss type.

    Parameters

    • abyssType: ZZZAbyssType = 'WitheringGarden'

      The type of abyss to retrieve information for. Defaults to 'WitheringGarden'.

    Returns Promise<ZZZAbyss>

    A Promise that resolves with an object containing the player's abyss data.

    Throws

    if UID parameter is missing or failed to be filled, or if the given abyss type parameter is invalid.

    Throws

    if failed to retrieve data, please double-check the provided UID.

characters

  • characters(): Promise<ZZZCharacterFull[]>

  • Retrieves the characters associated with the provided region and UID.

    Returns Promise<ZZZCharacterFull[]>

    A Promise that resolves to an array of ZZZCharacterFull objects.

    Throws

    if the region or UID parameters are missing or failed to be filled.

    Throws

    if failed to retrieve data, please double-check the provided UID.

getCharacterAvatar

  • getCharacterAvatar(avatarId): ZZZAvatar

  • Retrieves the URL of a character's avatar based on the provided avatar ID.

    Parameters

    • avatarId: number

      The ID of the character's avatar.

    Returns ZZZAvatar

    The URL of the character's avatar.

hollowZero

  • hollowZero(): Promise<ZZZHollowZero>

  • Retrieves the hollow zero data associated with the provided region and UID.

    Returns Promise<ZZZHollowZero>

    A Promise that resolves to the ZZZ hollow zero object.

    Throws

    if the region or UID parameters are missing or failed to be filled.

    Throws

    if failed to retrieve data, please double-check the provided UID.

note

  • note(): Promise<ZZZNote>

  • Retrieves the note associated with the provided region and UID.

    Returns Promise<ZZZNote>

    A Promise that resolves to the ZZZ note object.

    Throws

    if the region or UID parameters are missing or failed to be filled.

    Throws

    if failed to retrieve data, please double-check the provided UID.

records

  • records(): Promise<ZZZRecord>

  • Retrieves the records associated with the provided region and UID.

    Returns Promise<ZZZRecord>

    A Promise that resolves to the ZZZ record object.

    Throws

    if the region or UID parameters are missing or failed to be filled.

    Throws

    if failed to retrieve data, please double-check the provided UID.

shiyuDefense

  • shiyuDefense(scheduleType?): Promise<ZZZShiyuDefense>

  • Retrieves the Shiyu Defense data for the given schedule type.

    Parameters

    • scheduleType: ShiyuDefense = ShiyuDefense.CURRENT

      The schedule type of the Shiyu Defense, either CURRENT or PREVIOUS. Defaults to CURRENT.

    Returns Promise<ZZZShiyuDefense>

    A Promise that resolves with the Shiyu Defense data.

    Throws

    if the region or UID parameters are missing or failed to be filled.

    Throws

    if the given scheduleType parameter is invalid.

    Throws

    if failed to retrieve data, please double-check the provided UID.

Settings

Member Visibility

On This Page

Constructors
Methods