Skip to content

spotify-cli


spotify-cli / formatters

formatters

Per-command text formatters for --text output mode.

Each formatter receives the data object that output() would normally JSON-serialize and returns a human-readable string.

Functions

formatAlbum()

formatAlbum(data): string

Defined in: src/formatters.ts:204

Parameters

data

unknown

Returns

string


formatAlbumRemove()

formatAlbumRemove(data): string

Defined in: src/formatters.ts:244

Parameters

data

unknown

Returns

string


formatAlbumSave()

formatAlbumSave(data): string

Defined in: src/formatters.ts:240

Parameters

data

unknown

Returns

string


formatAlbumTracks()

formatAlbumTracks(data): string

Defined in: src/formatters.ts:218

Parameters

data

unknown

Returns

string


formatAudioFeatures()

formatAudioFeatures(data): string

Defined in: src/formatters.ts:276

Parameters

data

unknown

Returns

string


formatAuthStatus()

formatAuthStatus(data): string

Defined in: src/formatters.ts:427

Parameters

data

unknown

Returns

string


formatCommandHelp()

formatCommandHelp(data): string

Defined in: src/formatters.ts:462

Parameters

data

unknown

Returns

string


formatDevices()

formatDevices(data): string

Defined in: src/formatters.ts:147

Parameters

data

unknown

Returns

string


formatFollow()

formatFollow(data): string

Defined in: src/formatters.ts:408

Parameters

data

unknown

Returns

string


formatFollowing()

formatFollowing(data): string

Defined in: src/formatters.ts:399

Parameters

data

unknown

Returns

string


formatHelp()

formatHelp(data): string

Defined in: src/formatters.ts:437

Parameters

data

unknown

Returns

string


formatLogin()

formatLogin(data): string

Defined in: src/formatters.ts:418

Parameters

data

unknown

Returns

string


formatLogout()

formatLogout(): string

Defined in: src/formatters.ts:423

Returns

string


formatMe()

formatMe(data): string

Defined in: src/formatters.ts:379

Parameters

data

unknown

Returns

string


formatNext()

formatNext(): string

Defined in: src/formatters.ts:94

Returns

string


formatNow()

formatNow(data): string

Defined in: src/formatters.ts:76

Formats spotify now — shows currently playing track or "Not playing".

Parameters

data

unknown

Returns

string


formatPause()

formatPause(): string

Defined in: src/formatters.ts:90

Returns

string


formatPlay()

formatPlay(data): string

Defined in: src/formatters.ts:85

Parameters

data

unknown

Returns

string


formatPlaylist()

formatPlaylist(data): string

Defined in: src/formatters.ts:310

Parameters

data

unknown

Returns

string


formatPlaylistAdd()

formatPlaylistAdd(data): string

Defined in: src/formatters.ts:345

Parameters

data

unknown

Returns

string


formatPlaylistCreate()

formatPlaylistCreate(data): string

Defined in: src/formatters.ts:353

Parameters

data

unknown

Returns

string


formatPlaylistRemove()

formatPlaylistRemove(data): string

Defined in: src/formatters.ts:349

Parameters

data

unknown

Returns

string


formatPlaylistRename()

formatPlaylistRename(data): string

Defined in: src/formatters.ts:359

Parameters

data

unknown

Returns

string


formatPlaylists()

formatPlaylists(data): string

Defined in: src/formatters.ts:322

Parameters

data

unknown

Returns

string


formatPlaylistTracks()

formatPlaylistTracks(data): string

Defined in: src/formatters.ts:333

Parameters

data

unknown

Returns

string


formatPlaylistUpdate()

formatPlaylistUpdate(data): string

Defined in: src/formatters.ts:365

Parameters

data

unknown

Returns

string


formatPrev()

formatPrev(): string

Defined in: src/formatters.ts:98

Returns

string


formatQueue()

formatQueue(data): string

Defined in: src/formatters.ts:122

Parameters

data

unknown

Returns

string


formatQueueAdd()

formatQueueAdd(data): string

Defined in: src/formatters.ts:138

Parameters

data

unknown

Returns

string


formatRecent()

formatRecent(data): string

Defined in: src/formatters.ts:164

Parameters

data

unknown

Returns

string


formatRecommendations()

formatRecommendations(data): string

Defined in: src/formatters.ts:300

Parameters

data

unknown

Returns

string


formatRepeat()

formatRepeat(data): string

Defined in: src/formatters.ts:117

Parameters

data

unknown

Returns

string


formatSavedAlbums()

formatSavedAlbums(data): string

Defined in: src/formatters.ts:226

Parameters

data

unknown

Returns

string


formatSavedTracks()

formatSavedTracks(data): string

Defined in: src/formatters.ts:256

Parameters

data

unknown

Returns

string


formatSearch()

formatSearch(data): string

Defined in: src/formatters.ts:178

Parameters

data

unknown

Returns

string


formatSeek()

formatSeek(data): string

Defined in: src/formatters.ts:102

Parameters

data

unknown

Returns

string


formatShuffle()

formatShuffle(data): string

Defined in: src/formatters.ts:112

Parameters

data

unknown

Returns

string


formatTop()

formatTop(data): string

Defined in: src/formatters.ts:387

Parameters

data

unknown

Returns

string


formatTrack()

formatTrack(data): string

Defined in: src/formatters.ts:250

Parameters

data

unknown

Returns

string


formatTrackRemove()

formatTrackRemove(data): string

Defined in: src/formatters.ts:272

Parameters

data

unknown

Returns

string


formatTrackSave()

formatTrackSave(data): string

Defined in: src/formatters.ts:268

Parameters

data

unknown

Returns

string


formatTransfer()

formatTransfer(data): string

Defined in: src/formatters.ts:159

Parameters

data

unknown

Returns

string


formatUnfollow()

formatUnfollow(data): string

Defined in: src/formatters.ts:412

Parameters

data

unknown

Returns

string


formatVersion()

formatVersion(data): string

Defined in: src/formatters.ts:455

Parameters

data

unknown

Returns

string


formatVolume()

formatVolume(data): string

Defined in: src/formatters.ts:107

Parameters

data

unknown

Returns

string

MIT Licensed. Not affiliated with or endorsed by Spotify AB.