Skip to content

Function Quick Reference

This page is a quick index for the most used core functions. Each row links to the matching section in the detailed docs.

@luna/lib

FunctionWhat it doesDocs
redux.intercept(...)Subscribe to one or more Redux action types; can cancel dispatch by returning true.redux module
redux.interceptPromise(...)Wait for the next matching Redux action as a promise.redux module
redux.interceptActionResp(...)Trigger an action and await success/fail action responses.redux module
redux.actions[...]Dispatch typed TIDAL/Luna Redux actions.redux module
ipcRenderer.on(...)Register IPC listener with automatic unload cleanup.ipc module
ipcRenderer.once(...)Register one-shot IPC listener with cleanup.ipc module
ipcRenderer.onOpenUrl(...)Handle tidaluna: deep-link events.ipc module
ContextMenu.addButton(...)Create a reusable context menu button controller.ContextMenu
ContextMenu.onOpen(...)Handle generic context menu open events.ContextMenu
ContextMenu.onMediaItem(...)Handle media context menus (track/album/playlist).ContextMenu
PlayState.play(...)Start playback (optionally queue/play specific item first).PlayState
PlayState.pause()Pause playback.PlayState
PlayState.next() / previous()Skip to next/previous queue item.PlayState
PlayState.seek(seconds)Seek to position in current track.PlayState
PlayState.setShuffle(...)Toggle shuffle mode (with optional queue reshuffle).PlayState
PlayState.setRepeatMode(...)Set repeat mode directly.PlayState
PlayState.onState(...)Listen for playback-state changes.PlayState
MediaItem.fromId(...)Resolve media object from item id.MediaItem
MediaItem.fromPlaybackContext(...)Resolve media from current playback context.MediaItem
MediaItem.onMediaTransition(...)Listen when currently playing media changes.MediaItem
mediaItem.title() / artists() / album() / coverUrl()Read rich metadata from media item.MediaItem
mediaItem.playbackInfo(...)Fetch stream/playback metadata for quality/format work.MediaItem
mediaItem.download(...)Download media item stream to path.MediaItem
new StyleTag(...)Create managed style tag bound to unload lifecycle.StyleTag
observe(...) / observePromise(...)Watch DOM nodes by selector safely.helpers
safeTimeout(...) / safeInterval(...)Timer helpers with unload cleanup.helpers
getCredentials()Resolve current TIDAL credentials module values.helpers

@luna/ui

Function / ComponentWhat it doesDocs
Page.register(name, unloads, component?)Register/reuse a custom Luna page.Page API
page.open()Navigate and open a registered page.Page API
LunaSettingsStandard container for plugin settings UI.settings wrappers
LunaSwitchSettingToggle row for boolean settings.settings wrappers
LunaTextSettingText input row for string settings.settings wrappers
LunaNumberSettingNumber input row with bounds/callback.settings wrappers
LunaSelectSetting + LunaSelectItemSelect/multi-select setting row.settings wrappers
LunaButtonSettingAction button row (login, reset, sync, open).settings wrappers
confirm(options)Global confirm modal helper returning result promise.helper

@luna/lib.native

FunctionWhat it doesDocs
pkg()Resolve app/package metadata.app + updater
update(...)Trigger app update flow.app + updater
relaunch()Relaunch client process.app + updater
needsElevation()Check if elevated operation is needed.app + updater
runElevatedInstall(...)Execute elevated install/update operation.app + updater
showOpenDialog(...) / showSaveDialog(...)Open native file dialogs.dialog helpers
showMessageBox(...) / showErrorBox(...)Show native message/error dialogs.dialog helpers
clipboardWriteText(...)Copy text through native clipboard API.native messaging / shell
openExternal(url)Open URL with OS shell handler.native messaging / shell
fetchMediaItemStream(...)Build tagged/decrypted readable stream from playback info.streaming helpers
fetchStream(...)Low level stream fetch generator (urls to chunks).streaming helpers

@luna/dev

FunctionWhat it doesDocs
startReduxLog(regex, handler)Start Redux action logging with regex filter.logging controls
stopReduxLog()Stop Redux logging session.logging controls
startNativeIPCLog() / stopNativeIPCLog()Toggle Native to Render IPC logging.logging controls
startRenderIpcLog() / stopRenderIpcLog()Toggle Render to Native IPC logging.logging controls
getNativeIPCEvents() / getRenderIPCEvents()Get event maps used by IPC loggers.IPC event map helpers
startNativeDebugging()Enable native debug attach flow.native debugger helper

@luna/linux

FunctionWhat it doesDocs
showSettings()Open Linux bridge settings window.exported functions
hideSettings()Close Linux bridge settings window.exported functions