helixia.api
v1.0.4
Published
A Node.js module for accessing Helixia API services.
Downloads
10
Maintainers
Readme
🔹 helixia.api 1.0.4
Helixia API is a versatile module designed to interact with various APIs, including translation, music search, and GitHub user information. It provides a straightforward and efficient way to integrate these functionalities into your Node.js applications.
🔧 What does it do?
Helixia API offers a set of methods for interacting with different APIs:
- Translate: Translate text between languages.
- Lyrics: Fetch lyrics for a specific song.
- RandomMusic: Retrieve random music based on criteria.
- SearchMusic: Search for music by name, artist, or limit.
- GithubUser: Get information about a GitHub user.
🚀 Getting Started
- Install the package with npm:
npm install helixia.api
- Initialize the API:
const { HelixiaAPI } = require('helixia.api');
const api = new HelixiaAPI();
✨ Example Usage
Here are some examples to get you started:
const { HelixiaAPI } = require('helixia.api');
const api = new HelixiaAPI();
// Translate text
api.Translate({ text: 'Hello', to: 'es', from: 'en' })
.then(result => console.log(result))
.catch(error => console.error(error));
// Fetch song lyrics
api.Lyrics({ song: 'Shape of You' })
.then(result => console.log(result))
.catch(error => console.error(error));
// Get random music
api.RandomMusic({ limit: 5, type: 'pop' })
.then(result => console.log(result))
.catch(error => console.error(error));
// Search for music
api.SearchMusic({ name: 'Blinding Lights', artist: 'The Weeknd', limit: 3 })
.then(result => console.log(result))
.catch(error => console.error(error));
// Get GitHub user information
api.GithubUser({ name: 'topraqk1' })
.then(result => console.log(result))
.catch(error => console.error(error));
📂 Methods
- Translate - Translate text from one language to another:
api.Translate({ text: 'Hello', to: 'es', from: 'en' });
- Lyrics - Get lyrics for a specific song:
api.Lyrics({ song: 'Shape of You' });
- RandomMusic - Fetch random music based on limit and type:
api.RandomMusic({ limit: 5, type: 'hip-hop' });
- SearchMusic - Search for music by name, artist, and limit:
api.SearchMusic({ name: 'Blinding Lights', artist: 'The Weeknd', limit: 3 });
- GithubUser - Retrieve information about a GitHub user:
api.GithubUser({ name: 'topraqk1' });