Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SongAPIOptions

Options for searching songs from Database To search for all tracks with a specific term, surround the term with %. Eg. if the term is 'aaa', to get all songs containing 'aaa' in the title, put the term as '%aaa%' in 'song.title'.

Hierarchy

  • SongAPIOptions

Index

Properties

Optional album

album?: Partial<Album>

To search tracks by properties in album, specify this property.

Optional artist

artist?: Partial<Artists>

To search tracks by properties in artists, specify this property.

Optional genre

genre?: Partial<Genre>

To search tracks by properties in genre, specify this property.

Optional inclusive

inclusive?: boolean

If false, then the exact match of all options will be provided. If true, then even if a track matches one of the options, it will be returned. In terms of SQL, true will add 'AND' between where queries and false will add 'OR'.

Eg. If song.title is 'aaa' and album.album_name is 'bbb'

In this scenario if inclusive is false, then all tracks having title as 'aaa' AND album_name as 'bbb' will be returned

If inclusive is false then songs having title as 'aaa' OR album_name as 'bbb' will be returned

Optional playlist

playlist?: Partial<Playlist>

To search tracks by properties in playlist, specify this property.

Optional song

To search tracks by properties in song, specify this property.

Optional sortBy

To sort the results, specify this property

Generated using TypeDoc