LavaSearchPlugin
API reference for the LavaSearchPlugin in Moonlink.js
LavaSearchPlugin Class
The LavaSearchPlugin integrates with the LavaSearch Lavalink plugin to provide advanced search capabilities. It allows searching for various content types like tracks, albums, artists, playlists, and text.
This plugin requires a Lavalink server running the LavaSearch plugin.
Properties
| Property | Type | Description |
|---|---|---|
name | string | The name of the plugin: lavasearch-plugin. |
capabilities | string[] | Declares lavasearch capability. |
node | Node | The associated Node instance. |
Methods
load
loadmethod
Load Plugin
Initializes the plugin for a given node.
Parameters
noderequiredNode
Returns & Example
Returns
• void
// Called internally by PluginManager
::
unload
unloadmethod
Unload Plugin
Cleans up plugin resources.
Parameters
noderequiredNode
Returns & Example
Returns
• void
// Called internally by PluginManager
search
searchmethod
Perform LavaSearch
Performs a search using the LavaSearch API, supporting various content types.
Parameters
queryrequiredstring
optionsObject
options.sourcestring
youtube, spotify). options.typesstring
track,album,artist). Defaults to track,album,artist,playlist,text. Returns & Example
Returns
• Promise<ILavaSearchResultData> — The search results data.
const results = await plugin.search('Never Gonna Give You Up', { types: 'track,artist' });
console.log(results.tracks);
console.log(results.artists);