Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Song

Index

Constructors

constructor

  • new Song(res: any, key?: string, partial?: boolean, config?: Config): Song

Properties

Optional album

album: undefined | Album

artist

artist: Artist

Private config

config: Config

endpoint

endpoint: string

featuredTitle

featuredTitle: string

fullTitle

fullTitle: string

id

id: number

image

image: string

Private Optional key

key: undefined | string

partial

partial: boolean

raw

raw: any

Optional releasedAt

releasedAt: undefined | Date

thumbnail

thumbnail: string

title

title: string

url

url: string

Methods

fetch

  • fetch(): Promise<Song>
  • Fetches All Information about the Track and updates all the existing Properties (Requires Key)

    example

    const NewSong = await Song.fetch();

    Returns Promise<Song>

lyrics

  • lyrics(removeChorus?: boolean): Promise<string>
  • Fetches Lyrics of the Track

    example

    const Lyrics = await Song.lyrics(true);

    Parameters

    • removeChorus: boolean = false

    Returns Promise<string>

Generated using TypeDoc