Options
All
  • Public
  • Public/Protected
  • All
Menu

Module index

Index

References

Enumerations

Classes

Interfaces

Type aliases

Functions

References

RainwaveResponseTypes

Re-exports RainwaveResponseTypes

Type aliases

AlbumDiff

AlbumDiff: Pick<AlbumInList, "id" | "cool" | "cool_lowest" | "newest_song_time">[]

AllStationsInfo

AllStationsInfo: Record<Station, StationInfo>

AlreadyVoted

AlreadyVoted: AlreadyVotedEntry[]

LiveVoting

LiveVoting: Record<number, LiveVotingEntry[]>

PlaybackHistory

PlaybackHistory: PlaybackHistoryEntry[]

Relays

Relays: Relay[]

RequestLine

RequestLine: RequestLineEntry[]

Requests

Requests: Request[]

StationSongCount

StationSongCount: StationSongCountByStation[]

Stations

Stations: StationDescription[]

Top100

Top100: Top100Song[]

UnratedSongs

UnratedSongs: UnratedSong[]

UserRecentVotes

UserRecentVotes: UserRecentVote[]

Functions

getValidatedRatingUser

  • Takes a number and returns a type-guarded {@link ValidatedRatingUser}.

    Numbers below 1 are changed to 1. Numbers above 5 are changed to 5. Numbers in-between are rounded to their closest value in {@link ValidatedRatingUser}.

    Parameters

    • ratingUser: number

      Any number to be clamped to a valid Rainwave rating between 1 and 5.

    Returns ValidatedSongRatingUser

Generated using TypeDoc