Options
All
  • Public
  • Public/Protected
  • All
Menu

@lautag/api-browser - v3.0.1

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

IApiCurrentSong

IApiCurrentSong: IApiSong

IApiLastSongs

IApiLastSongs: IApiSong[]

NormalizedPagination

NormalizedPagination: { pagination: IPaginationInfo; stations: IApiStation[] }

Type declaration

NormalizedResp

NormalizedResp: IApiStation[] | NormalizedPagination

Variables

Const BASE_URL

BASE_URL: "https://api.laut.fm/" = "https://api.laut.fm/"

Functions

allListeners

  • allListeners(): Promise<number>

  • Gets total number of listeners

    Returns Promise<number>

allStations

assignOptions

formatResult

genre

  • Gets raw genres objects related to another genre

    Parameters

    • genre: string

    Returns Promise<IApiGenre>

genres

  • genres(): Promise<string[]>

  • Get all genres available

    Returns Promise<string[]>

genresRaw

hasLetter

  • hasLetter(letter: string): Promise<boolean>

  • Determines if any stations starts with a certain letter

    Parameters

    • letter: string

    Returns Promise<boolean>

hasStation

  • hasStation(station: string): Promise<boolean>

  • Indicates if a station exists

    Parameters

    • station: string

    Returns Promise<boolean>

isServerRunning

  • isServerRunning(): Promise<boolean>

  • Gets the boolean value if the server is running or not

    Returns Promise<boolean>

letters

  • letters(): Promise<string[]>

  • Gets unique array of all first letters of stations

    Returns Promise<string[]>

listeners

  • listeners(station: string): Promise<number>

  • Gets listeners for a particular station

    Parameters

    • station: string

    Returns Promise<number>

liveStations

  • liveStations(): Promise<string[]>

  • Get names of all stations broadcasting live

    Returns Promise<string[]>

liveStationsRaw

numLiveStations

  • numLiveStations(): Promise<number>

  • Indicate how many stations are broadcasting live

    Returns Promise<number>

qs

query

  • query(url: string, params?: Partial<IOptions>): Promise<any>

  • Parameters

    • url: string
    • Default value params: Partial<IOptions> = {}

    Returns Promise<any>

relatedGenres

  • relatedGenres(genre: string): Promise<string[]>

  • Parameters

    • genre: string

    Returns Promise<string[]>

serverStatus

  • serverStatus(): Promise<{ message: string; running: boolean }>

  • Gets the status object of the server

    Returns Promise<{ message: string; running: boolean }>

serverTime

  • serverTime(): Promise<string>

  • Gets the time from the server

    Returns Promise<string>

stationIsLive

  • stationIsLive(station: string): Promise<boolean>

  • Determine if a station is currently broadcasting live

    Parameters

    • station: string

    Returns Promise<boolean>

stationNames

  • stationNames(): Promise<string[]>

  • Gets all station names

    Returns Promise<string[]>

stationStartsWith

  • Get stations beginning with a certain letter or number

    Parameters

    • startw: string | number
    • Default value options: Partial<IOptions> = {}

    Returns Promise<NormalizedResp>

stations

  • Gets information for specific stations

    Parameters

    • stations: string[]
    • Default value options: Partial<IOptions> = {}

    Returns Promise<IApiStation[]>

stationsByGenre

  • Get all stations of a particular genre

    Parameters

    • genre: string
    • Default value options: Partial<IOptions> = {}

    Returns Promise<NormalizedResp>

Generated using TypeDoc