1.0.4 • Published 8 months ago
music-toolbox v1.0.4
🎵 Music Toolbox
Welcome to the Music Toolbox! 🎶 This simple Node.js package allows you to interact with the music API provided by Rosssio.dev. With it, you can search for songs, check cache information, and retrieve cached songs — all with easy-to-use methods!
🌟 Features
- Search for songs by name or artist
- Check how much time is left on a cached song
- Get the full list of cached songs
🚀 Installation
To use the music-toolbox
, you need to have Node.js installed. Once you do, you can install the package via npm:
npm install music-toolbox
🛠️ Usage
Here are the available methods and how to use them:
1. search(query)
Search for a song by name or artist.
const musicToolbox = require('music-toolbox');
musicToolbox.search('Bohemian Rhapsody').then(data => {
console.log(data); // Song details
});
2. ttl(query)
Check how much time is left on a cached song.
musicToolbox.ttl('Bohemian Rhapsody').then(ttl => {
console.log(ttl); // Time left on the cached song
});
3. cache()
Get the full list of cached songs.
musicToolbox.cache().then(cachedSongs => {
console.log(cachedSongs); // List of cached songs
});
📚 API Docs
For more details on the API, check out the official API documentation.
⚙️ Dependencies
axios
: For making HTTP requests