Options
All
  • Public
  • Public/Protected
  • All
Menu

@moosync/moosync-types

Index

Type aliases

ContextMenuTypes

ContextMenuTypes: "SONGS" | "GENERAL_SONGS" | "PLAYLIST" | "GENERAL_PLAYLIST" | "PLAYLIST_CONTENT" | "QUEUE_ITEM" | "ARTIST" | "ALBUM"

EntityApiOptions

EntityApiOptions: { inclusive?: boolean } & ({ album: Partial<Album> | boolean } | { artist: Partial<Artists> | boolean } | { genre: Partial<Genre> | boolean } | { playlist: Partial<Playlist> | boolean })

Options for searching entities like Albums, Artists, Playlists or Genre

ExtensionContextMenuHandlerArgs

ExtensionContextMenuHandlerArgs<T>: T extends "SONGS" ? Song[] : T extends "PLAYLIST" ? Playlist : T extends "PLAYLIST_CONTENT" ? Song[] : T extends "QUEUE_ITEM" ? Song : T extends "ARTIST" ? Artists : T extends "ALBUM" ? Album : undefined

Type parameters

ExtensionContextMenuItem

ExtensionContextMenuItem<T>: { children?: ExtensionContextMenuItem<T>[]; disabled?: boolean; label: string; type: T; handler?: any }

Type parameters

Type declaration

ExtensionPreferenceGroup

ExtensionPreferenceGroup: { description: string; key: string; title: string } & ({ items: Checkbox[]; type: "CheckboxGroup" } | { default: string; inputType?: "text" | "number" | "password" | "url"; type: "EditText" } | { default: string; type: "FilePicker" } | { default: PathGroup[]; type: "DirectoryGroup" } | { items: Buttons[]; type: "ButtonGroup" } | { default: number; type: "ProgressBar" })

ExtraExtensionEventData

ExtraExtensionEventData<T>: T extends "requestedPlaylistSongs" ? [playlistID: string] : T extends "oauthCallback" ? [url: string] : T extends "songQueueChanged" ? [songQueue: SongQueue] : T extends "seeked" ? [newTime: number] : T extends "volumeChanged" ? [newVolume: number] : T extends "playerStateChanged" ? [newState: PlayerState] : T extends "songChanged" ? [song: Song] : T extends "preferenceChanged" ? [preference: { key: string; value: unknown }] : []

Type parameters

ExtraExtensionEventReturnType

ExtraExtensionEventReturnType<T>: T extends "requestedPlaylists" ? GetPlaylistReturnType : T extends "requestedPlaylistSongs" ? GetPlaylistSongsReturnType : void

Type parameters

ExtraExtensionEventTypes

ExtraExtensionEventTypes: "requestedPlaylists" | "requestedPlaylistSongs" | "oauthCallback" | "songQueueChanged" | "seeked" | "volumeChanged" | "playerStateChanged" | "songChanged" | "preferenceChanged"

GetPlaylistReturnType

GetPlaylistReturnType: { playlists: Playlist[] }

Type declaration

GetPlaylistSongsReturnType

GetPlaylistSongsReturnType: { songs: Song[] }

Type declaration

PlayerState

PlayerState: "PLAYING" | "PAUSED" | "STOPPED" | "LOADING"

PlayerTypes

PlayerTypes: "LOCAL" | "YOUTUBE" | "SPOTIFY" | "URL"

SongSortOptions

SongSortOptions: { asc: boolean; type: keyof Song }

Sort by key in Song. If asc is true then results will be sorted in ascending otherwise descending

Type declaration

  • asc: boolean
  • type: keyof Song

Generated using TypeDoc