Skip to main content

Class: MusicClient

Youtube Music Client

Constructors

constructor

new MusicClient(options?)

Parameters

NameType
optionsPartial<HTTPOptions>

Methods

getLyrics

getLyrics(id): Promise<undefined | MusicLyrics>

Get lyrics of a song

Parameters

NameType
idstring

Returns

Promise<undefined | MusicLyrics>


search<T>(query, type?): Promise<MusicSearchResult<T>>

Searches for video, song, album, playlist, or artist

Type parameters

NameType
Textends MusicSearchType

Parameters

NameTypeDescription
querystringThe search query
type?TSearch type

Returns

Promise<MusicSearchResult<T>>


searchAll

searchAll(query): Promise<MusicSearchResult<undefined>>

Searches for all video, song, album, playlist, or artist

Parameters

NameTypeDescription
querystringThe search query

Returns

Promise<MusicSearchResult<undefined>>