omenapi
v1.0.0
Published
A Node.js client for the OmenList API
Downloads
3
Readme
OmenList API Client
A Node.js client for the OmenAPI.
Installation
npm install omenapi
Usage
Initialize the API Client
const OmenListAPI = require('omenapi');
const api = new OmenListAPI('your-api-key');
// Or set the API key later
api.setApiKey('your-api-key');
Generate a Welcome Image
api.Welcome()
.setUser('userID')
.setMemberCounter(100)
.setGuildIcon('https://example.com/icon.png')
.setGuildName('Guild Name')
.setBackground('https://example.com/background.jpg')
.generate()
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
Download Videos
Download MP3
const mp3Downloader = api.downloadMP3();
// Download MP3 from URL
mp3Downloader.downloadFromURL('https://example.com/video')
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
// Download MP3 from query
mp3Downloader.downloadFromQuery('example query')
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
Download MP4
const mp4Downloader = api.downloadMP4();
// Download MP4 from URL
mp4Downloader.downloadFromURL('https://example.com/video')
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
// Download MP4 from query
mp4Downloader.downloadFromQuery('example query')
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
Generate Logos
Generate Logo
// Generate logo with one input
api.logo('arcane', 'Your Text')
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
// Generate logo with two inputs
api.logo('wolf', 'Text1', 'Text2')
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
Handle Invalid Type
api.logo('invalidType', 'Your Text')
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error.message); // Output: Error: Invalid type: invalidType. Valid types are: ...
});
Fetch Anime Endpoints
const anime = api.Anime();
anime.couple()
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
anime.chika()
.then(data => {
console.log(data);
})
.catch(error => {
console.error('Error:', error);
});
// Similarly for other endpoints like girls, ari, badgirl, etc.
API Methods
setUser(userID)
Sets the user ID for the welcome image.
userID
- The ID of the user.
setMemberCounter(memberCount)
Sets the member counter for the welcome image.
memberCount
- The number of members in the guild.
setGuildIcon(guildIcon)
Sets the guild icon URL for the welcome image.
guildIcon
- The URL of the guild icon.
setGuildName(guildName)
Sets the guild name for the welcome image.
guildName
- The name of the guild.
setBackground(backgroundUrl)
Sets the background URL for the welcome image.
backgroundUrl
- The URL of the background image.
generate()
Generates the welcome image.
downloadMP3()
Returns an instance of the MP3 downloader.
downloadMP4()
Returns an instance of the MP4 downloader.
logo(type, text, text2 = null)
Generates a logo with the specified type and text inputs.
Anime()
Returns an instance of the anime fetcher.
License
MIT