# Welcome
## [](/)
[](https://github.com/SrGobi/canvacard)
[](https://nodei.co/npm/canvacard/)
     [](https://discord.gg/cqrN3Eg)
### [](/)
```console
npm i canvacard
```
## [](/)
For **CommonJS**
```javascript
const canvacard = require("canvacard");
```
For **EsModule** And **TypeScript**
```typescript
import canvacard from "canvacard";
```
## β¨Features
* πͺ **Open source and no privacy concerns, fully transparent** - Canvacard is open source and free. You can contribute and you don't have to worry about privacy.
* πͺ **Easy to use** - Canvacard offers an intuitive and easy API to efficiently generate images, perfect for developers of all levels.
* π **Speed ββand optimization** - The libraries it uses are highly optimized, offering exceptional performance when creating images.
* π **Typescript support** - Canvacard is built in Typescript, which allows for the use of type definitions and improves the developer experience.
* π¨ **More than 50 customization options** - You have access to many tools to completely adjust and modify your images or cards.
* πΌοΈ **Creating interactive and personalized cards** - Canvacard is perfect for creating custom cards for Discord, adding graphics, banners, badges, and more.
* π οΈ **Object Oriented Design** - Canvacard is built with an object-oriented programming approach, making it easy to reuse and create complex cards.
* π€ **Ideal for beginners** - The API and documentation are simple, making it accessible even to those with little experience handling images.
* π‘ **Register fonts** - Not only can you use the fonts from your machine, if you also use it for a server you can register the fonts you want!
For **CommonJS**
```javascript
const { registerFont } = require("canvacard");
// Path to source file and alias
const fontPath = "./path/to/font.ttf";
const fontName = "CustomFont";
registerFont(fontPath, fontName);
console.log(`Fuente ${fontName} registrada exitosamente.`);
```
For **EsModule** And **TypeScript**
```typescript
import { registerFont } from "canvacard";
// Define types for clarity
const fontPath: string = "./path/to/font.ttf";
const fontName: string = "CustomFont";
registerFont(fontPath, fontName);
console.log(`Fuente ${fontName} registrada exitosamente.`);
```
## π¦Examples
### [Rank Card](https://canvacard.srgobi.com/classes/rank)
```js
const { AttachmentBuilder } = require("discord.js");
const canvacard = require("canvacard");
const userData = getDataSomehow(); // Simulates obtaining user data
const rank = new canvacard.Rank()
.setAvatar(userData.avatarURL, userData.avatar_decoration_data.asset, false)
.setBanner(userData.bannerURL, true)
.setBadges(userData.flags, userData.bot, true)
.setBorder(["#22274a", "#001eff"], "vertical")
.setCurrentXP(userData.xp)
.setRequiredXP(userData.requiredXP)
.setRank(1, "RANK", true)
.setLevel(20, "LEVEL")
.setStatus("online")
.setProgressBar(["#14C49E", "#FF0000"], "GRADIENT", true)
.setUsername(userData.username, userData.discriminator, "#FFFFFF")
.setCreatedTimestamp(userData.createdTimestamp);
rank.build("Cascadia Code PL")
.then(data => {
// Use AttachmentBuilder to upload the file
const attachment = new AttachmentBuilder(data, { name: "RankCard.png" });
message.channel.send({ content: "Here is your rank card:", files: [attachment] });
})
.catch(err => console.error("Error creating rank card:", err));
```
PREVIEW
\
    
### [Welcome / Leave Card](https://canvacard.srgobi.com/classes/welcomeleave)
```js
const canvacard = require("canvacard");
const img = "https://cdn.discordapp.com/embed/avatars/0.png";
const background = "https://i.imgur.com/5O7xmVe.png";
const welcomer = new canvacard.WelcomeLeave()
.setAvatar(img)
.setBackground('COLOR', '#000000')
.setTitulo("Card Title π", '#FFFFFF')
.setSubtitulo("Card Caption π", '#FFFFFF')
.setOpacityOverlay(1)
.setColorCircle('#FFFFFF')
.setColorOverlay('#5865F2')
.setTypeOverlay('ROUNDED');
welcomer.build("Cascadia Code PL, Noto Color Emoji")
.then(data => {
// Use AttachmentBuilder to upload the file
const attachment = new AttachmentBuilder(data, { name: "WelcomeCard.png" });
message.channel.send({ content: "Here is your welcome card:", files: [attachment] });
})
.catch(err => console.error("Error creating welcome card:", err));
```
PREVIEW
\
   
### [Spotify Card](https://canvacard.srgobi.com/classes/spotify)
```js
const canvacard = require("canvacard");
const spotify = new canvacard.Spotify()
.setAuthor("SAIKO")
.setAlbum("SAKURA π")
.setStartTimestamp(Date.now() - 10000)
.setEndTimestamp(Date.now() + 50000)
.setImage("https://i.scdn.co/image/ab67616d00001e02e346fc6f767ca2ac8365fe60")
.setTitle("YO LO SOΓΓ");
spotify.build("Cascadia Code PL, Noto Color Emoji")
.then(data => {
// Use AttachmentBuilder to upload the file
const attachment = new AttachmentBuilder(data, { name: "SpotifyCard.png" });
message.channel.send({ content: "Here is your spotify card:", files: [attachment] });
})
.catch(err => console.error("Error creating spotify card:", err));
```
### [Canvacard Circle](https://canvacard.srgobi.com/classes/canvacard)
```js
const canvacard = require("canvacard");
canvacard.Canvas.circle(data.avatarURL)
.then(data => {
canvacard.write(data, "circle.png");
})
.catch(console.error);
```
### [Otros ejemplos](https://canvacard.srgobi.com)
```js
const { Client, GatewayIntentBits, AttachmentBuilder } = require("discord.js");
const canvacard = require("canvacard");
const client = new Client({
intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages, GatewayIntentBits.MessageContent]
});
client.on('ready', () => {
console.log('Β‘I am online!');
});
client.on('messageCreate', async (message) => {
if (message.author.bot) return;
if (message.content === '!triggered') {
try {
let avatar = message.author.displayAvatarURL({ dynamic: false, format: 'png' });
let image = await canvacard.Canvas.trigger(avatar);
// Enviar el archivo generado usando AttachmentBuilder
let attachment = new AttachmentBuilder(image, { name: 'triggered.gif' });
await message.channel.send({ content: 'Here is your "triggered" image!', files: [attachment] });
} catch (err) {
console.error('Error generating image triggered:', err);
}
}
});
client.login('Your_Bot_Token_Here');
```
PREVIEW
\
# Classes
# Welcome / Leave
### Classes
[WelcomeLeave](#WelcomeLeave)
### Functions
[setAvatar(value)](#setAvatar) β [`WelcomeLeave`](#WelcomeLeave)
Set the avatar of the card
[setTitulo(value, color)](#setTitulo) β [`WelcomeLeave`](#WelcomeLeave)
Set the title of the card
[setSubtitulo(value, color)](#setSubtitulo) β [`WelcomeLeave`](#WelcomeLeave)
Set the subtitle of the card
[setColorCircle(value)](#setColorCircle) β [`WelcomeLeave`](#WelcomeLeave)
Set the color of the circle
[setColorOverlay(value)](#setColorOverlay) β [`WelcomeLeave`](#WelcomeLeave)
Set the color of the overlay
[setOpacityOverlay(value)](#setOpacityOverlay) β [`WelcomeLeave`](#WelcomeLeave)
Set the opacity of the overlay
[setBackground(type, data)](#setBackground) β [`WelcomeLeave`](#WelcomeLeave)
Set background image/color of the card
[setTypeOverlay(type)](#setTypeOverlay) β [`WelcomeLeave`](#WelcomeLeave)
Set the type of overlay
[build(\[font\])](#build) β `Promise.`
Build the card
### WelcomeLeave
**Kind**: global class
#### new WelcomeLeave()
Welcome or Leave card creator
PREVIEW
\
  
**Example**
```js
const welcome = new canvacard.WelcomeLeave()
.setAvatar(data.avatarURL)
.setBackground('COLOR', '#000000')
.setTitulo("Titulo de la Tarjetaπ", '#FFFFFF')
.setSubtitulo("Subtitulo de la Tarjeta π", '#FFFFFF')
.setOpacityOverlay(1)
.setColorCircle('#FFFFFF')
.setColorOverlay('#5865F2')
.setTypeOverlay('ROUNDED');
const welcomeImage = await welcome.build("Suravaram");
canvacard.write(welcomeImage, "./welcomer.png");
```
### setAvatar(value) β [`WelcomeLeave`](#WelcomeLeave)
Set the avatar of the card
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` Missing field: avatar
| Param | Type | Description |
| ----- | -------------------- | -------------------- |
| value | `string` \| `Buffer` | Avatar URL or Buffer |
### setTitulo(value, color) β [`WelcomeLeave`](#WelcomeLeave)
Set the title of the card
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` The title must be a string
| Param | Type | Description |
| ----- | -------- | -------------------------- |
| value | `string` | Title value |
| color | `string` | HTML5 color code "#000000" |
### setSubtitulo(value, color) β [`WelcomeLeave`](#WelcomeLeave)
Set the subtitle of the card
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` The subtitle must be a string
| Param | Type | Description |
| ----- | -------- | -------------------------- |
| value | `string` | Subtitle value |
| color | `string` | HTML5 color code "#000000" |
### setColorCircle(value) β [`WelcomeLeave`](#WelcomeLeave)
Set the color of the circle
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` The color must be a string
| Param | Type | Description |
| ----- | -------- | -------------------------- |
| value | `string` | HTML5 color code "#000000" |
### setColorOverlay(value) β [`WelcomeLeave`](#WelcomeLeave)
Set the color of the overlay
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` The color must be a string
| Param | Type | Description |
| ----- | -------- | -------------------------- |
| value | `string` | HTML5 color code "#000000" |
### setOpacityOverlay(value) β [`WelcomeLeave`](#WelcomeLeave)
Set the opacity of the overlay
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` The opacity must be a number
| Param | Type | Description |
| ----- | -------- | ---------------------- |
| value | `number` | Opacity value (0 to 1) |
### setBackground(type, data) β [`WelcomeLeave`](#WelcomeLeave)
Set background image/color of the card
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` Missing field: data
| Param | Type | Description |
| ----- | ---------------------- | ---------------------------- |
| type | `"COLOR"` \| `"IMAGE"` | Type of background |
| data | `string` | Image URL or HTML color code |
### setTypeOverlay(type) β [`WelcomeLeave`](#WelcomeLeave)
Set the type of overlay
**Kind**: global function\
**Returns**: [`WelcomeLeave`](#WelcomeLeave) - The current instance of WelcomeLeave\
**Throws**:
* `APIError` Missing field: type
| Param | Type | Description |
| ----- | ---------------------------- | --------------- |
| type | `"RECTANGLE"` \| `"ROUNDED"` | Type of overlay |
### build(\[font]) β `Promise.`
Build the card
**Kind**: global function\
**Returns**: `Promise.` - Card image in buffer format\
**Throws**:
* `APIError` Error loading background image
| Param | Type | Default | Description |
| ------- | -------- | --------- | ----------------------- |
| \[font] | `string` | `"Arial"` | Font to use in the card |
# FortniteShop
### Classes
[FortniteShop](#FortniteShop)
### Functions
[setToken(value)](#setToken) β [`FortniteShop`](#FortniteShop)
Set the Fortnite API token
[setText(value)](#setText) β [`FortniteShop`](#FortniteShop)
Set the text for the Fortnite Shop card
[build(\[font\])](#build) β `Promise.`
Build the Fortnite Shop card
### FortniteShop
**Kind**: global class
#### new FortniteShop()
Fortnite Shop card creator
PREVIEW
\
To obtain a Fortnite API token, visit [fortnite-api.com](https://fortnite-api.com/)
**Example**
```js
const shop = new canvacard.FortniteShop()
.setToken("f4a26b940ef54a9a4238cef040bd08fa9001cd6c")
.setText("footer", "ESP CUSTOMS X FORTNITE")
const FortniteShopImage = await shop.build("Luckiest Guy");
canvacard.write(FortniteShopImage, "./fortnite_shop.png");
```
### setToken(value) β [`FortniteShop`](#FortniteShop)
Set the Fortnite API token
**Kind**: global function\
**Returns**: [`FortniteShop`](#FortniteShop) - The current instance of FortniteShop\
**Throws**:
* `APIError` If the value is not a string
| Param | Type | Description |
| ----- | -------- | ------------------ |
| value | `string` | Fortnite API token |
### setText(value) β [`FortniteShop`](#FortniteShop)
Set the text for the Fortnite Shop card
**Kind**: global function\
**Returns**: [`FortniteShop`](#FortniteShop) - The current instance of FortniteShop\
**Throws**:
* `APIError` If the value is not a string
| Param | Type | Description |
| ----- | -------- | ------------------------ |
| value | `string` | Text to set for the card |
### build(\[font]) β `Promise.`
Build the Fortnite Shop card
**Kind**: global function\
**Returns**: `Promise.` - Card image in buffer format\
**Throws**:
* `APIError` If the token is not provided
| Param | Type | Default | Description |
| ------- | -------- | --------------------- | ------------------------ |
| \[font] | `string` | `""Arial""` | Font to use for the card |
# Canvacard
### Classes
[Canvacard](#Canvacard)
### Functions
[trigger(image)](#trigger) β `Promise.`
Trigger an image
[invert(image)](#invert) β `Promise.`
Invert an image
[sepia(image)](#sepia) β `Promise.`
Sepia an image
[greyscale(image)](#greyscale) β `Promise.`
Greyscale an image
[brightness(image, amount)](#brightness) β `Promise.`
Edit the brightness of the image
[darkness(image, amount)](#darkness) β `Promise.`
Darken an image
[threshold(image, amount)](#threshold) β `Promise.`[convolute(image, matrix, opaque)](#convolute) β `Promise.`
Convolute an image
[pixelate(image, pixels)](#pixelate) β `Promise.`
Pixelate an image
[sharpen(image, lvl)](#sharpen) β `Promise.`
Sharpen an image
[burn(image, lvl)](#burn) β `Promise.`
Burn an image
[circle(image)](#circle) β `Promise.`
Circle an image
[fuse(image1, image2)](#fuse) β `Promise.`
Fuse two images
[resize(image, width, height)](#resize) β `Promise.`
Resize an image
[kiss(image1, image2)](#kiss) β `Promise.`
Kiss someone ( Ν‘Β° ΝΚ Ν‘Β°)
[spank(image1, image2)](#spank) β `Promise.`
To spank someone ( Ν‘Β° ΝΚ Ν‘Β°)
[slap(image1, image2)](#slap) β `Promise.`
Slap someone ( Ν‘Β° ΝΚ Ν‘Β°)
[facepalm(image)](#facepalm) β `Promise.`
Facepalm someone
[colorfy(image, color)](#colorfy) β `Promise.`
Colorfy an image
[distracted(image1, image2, image3)](#distracted) β `Promise.`
Distract someone
[jail(image, greyscale)](#jail) β `Promise.`
Create a jail image
[bed(image1, image2)](#bed) β `Promise.`
Create a bed image
[delete(image, dark)](#delete) β `Promise.`
Create a deleted image
[gradient(colorFrom, colorTo, width, height)](#gradient) β `Promise.`
Create a gradient image
[quote(options, \[font\])](#quote) β `Promise.`
Create a fake quote image
[phub(options, \[font\])](#phub) β `Promise.`
PornHub Comment
[wanted(image)](#wanted) β `Promise.`
Create a "wanted" image
[wasted(image)](#wasted) β `Promise.`
Create a "wasted" image
[youtube(ops)](#youtube) β `Promise.`
Create a YouTube comment image
[write(data, name)](#write) β `void`
Writes data as a file
[reply(options)](#reply) β `Promise.`
Discord Reply Clone
### Canvacard
**Kind**: global class
#### new Canvacard()
Image generator
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.trigger("./image.png")
.then(triggered => {
canvacard.write(triggered, "triggered.gif");
})
.catch(console.error);
```
### trigger(image) β `Promise.`
Trigger an image
**Kind**: global function\
**Returns**: `Promise.` - Triggered image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | ---------------- |
| image | `string` \| `Buffer` | Image to trigger |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.trigger("./image.png")
.then(triggered => {
canvacard.write(triggered, "triggered.gif");
})
.catch(console.error);
```
### invert(image) β `Promise.`
Invert an image
**Kind**: global function\
**Returns**: `Promise.` - Inverted image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | --------------- |
| image | `string` \| `Buffer` | Image to invert |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.invert("./image.png")
.then(inverted => {
canvacard.write(inverted, "inverted.png");
})
.catch(console.error);
```
### sepia(image) β `Promise.`
Sepia an image
**Kind**: global function\
**Returns**: `Promise.` - Sepia image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | -------------- |
| image | `string` \| `Buffer` | Image to sepia |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.sepia("./image.png")
.then(sepia => {
canvacard.write(sepia, "sepia.png");
})
.catch(console.error);
```
### greyscale(image) β `Promise.`
Greyscale an image
**Kind**: global function\
**Returns**: `Promise.` - Greyscale image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | ------------------ |
| image | `string` \| `Buffer` | Image to greyscale |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.greyscale("./image.png")
.then(greyscale => {
canvacard.write(greyscale, "greyscale.png");
})
.catch(console.error);
```
### brightness(image, amount) β `Promise.`
Edit the brightness of the image
**Kind**: global function\
**Returns**: `Promise.` - Brightened image\
**Throws**:
* `APIError` If image is not provided o la cantidad no es un nΓΊmero
| Param | Type | Description |
| ------ | -------------------- | -------------------- |
| image | `string` \| `Buffer` | Image to brighten |
| amount | `number` | Amount of brightness |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.brightness("./image.png", 50)
.then(brightened => {
canvacard.write(brightened, "brightened.png");
})
.catch(console.error);
```
### darkness(image, amount) β `Promise.`
Darken an image
**Kind**: global function\
**Returns**: `Promise.` - Darkened image\
**Throws**:
* `APIError` If image is not provided o la cantidad no es un nΓΊmero
| Param | Type | Description |
| ------ | -------------------- | ------------------ |
| image | `string` \| `Buffer` | Image to darken |
| amount | `number` | Amount of darkness |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.darkness("./image.png", 50)
.then(darkened => {
canvacard.write(darkened, "darkened.png");
})
.catch(console.error);
```
### threshold(image, amount) β `Promise.`
**Kind**: global function\
**Returns**: `Promise.` - Thresholded image\
**Throws**:
* `APIError` If image is not provided o la cantidad no es un nΓΊmero
**Descrioption**: Threshold an image
| Param | Type | Description |
| ------ | -------------------- | ------------------- |
| image | `string` \| `Buffer` | Image to threshold |
| amount | `number` | Amount of threshold |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.threshold("./image.png", 128)
.then(thresholded => {
canvacard.write(thresholded, "thresholded.png");
})
.catch(console.error);
```
### convolute(image, matrix, opaque) β `Promise.`
Convolute an image
**Kind**: global function\
**Returns**: `Promise.` - Convoluted image\
**Throws**:
* `APIError` If image is not provided o la matriz no es un Array
| Param | Type | Description |
| ------ | -------------------- | ----------------------------- |
| image | `string` \| `Buffer` | Image to convolute |
| matrix | `Array.` | Convolution matrix |
| opaque | `boolean` | If the image should be opaque |
**Example**
```js
const canvacard = require("canvacard");
const matrix = [0, -1, 0, -1, 5, -1, 0, -1, 0]; // Ejemplo de matriz de convoluciΓ³n
canvacard.Canvas.convolute("./image.png", matrix, true)
.then(convoluted => {
canvacard.write(convoluted, "convoluted.png");
})
.catch(console.error);
```
### pixelate(image, pixels) β `Promise.`
Pixelate an image
**Kind**: global function\
**Returns**: `Promise.` - Pixelated image\
**Throws**:
* `APIError` If image is not provided o los pΓxeles no son un nΓΊmero
| Param | Type | Description |
| ------ | -------------------- | ----------------- |
| image | `string` \| `Buffer` | Image to pixelate |
| pixels | `number` | Amount of pixels |
**Example**
````js
const canvacard = require("canvacard");
canvacard.Canvas.pixelate("./image.png", 5)
.then(pixelated => {
canvacard.write(pixelated, "pixelated.png");
})
.catch(console.error);
## sharpen(image, lvl) β Promise.<Buffer>
Sharpen an image
**Kind**: global function
**Returns**: Promise.<Buffer> - Sharpened image
**Throws**:
- APIError If image is not provided o el nivel no es un nΓΊmero
| Param | Type | Description |
| --- | --- | --- |
| image | string \| Buffer | Image to sharpen |
| lvl | number | Level of sharpening |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.sharpen("./image.png", 1)
.then(sharpened => {
canvacard.write(sharpened, "sharpened.png");
})
.catch(console.error);
````
### burn(image, lvl) β `Promise.`
Burn an image
**Kind**: global function\
**Returns**: `Promise.` - Burned image\
**Throws**:
* `APIError` If image is not provided o el nivel no es un nΓΊmero
| Param | Type | Description |
| ----- | -------------------- | ---------------- |
| image | `string` \| `Buffer` | Image to burn |
| lvl | `number` | Level of burning |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.burn("./image.png", 1)
.then(burned => {
canvacard.write(burned, "burned.png");
})
.catch(console.error);
```
### circle(image) β `Promise.`
Circle an image
**Kind**: global function\
**Returns**: `Promise.` - Circled image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | --------------- |
| image | `string` \| `Buffer` | Image to circle |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.circle("./image.png")
.then(circled => {
canvacard.write(circled, "circled.png");
})
.catch(console.error);
```
### fuse(image1, image2) β `Promise.`
Fuse two images
**Kind**: global function\
**Returns**: `Promise.` - Fused image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ------ | -------------------- | ------------ |
| image1 | `string` \| `Buffer` | First image |
| image2 | `string` \| `Buffer` | Second image |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.fuse("./image1.png", "./image2.png")
.then(fused => {
canvacard.write(fused, "fused.png");
})
.catch(console.error);
```
### resize(image, width, height) β `Promise.`
Resize an image
**Kind**: global function\
**Returns**: `Promise.` - Resized image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ------ | -------------------- | --------------- |
| image | `string` \| `Buffer` | Image to resize |
| width | `number` | Width |
| height | `number` | Height |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.resize("./image.png", 500, 500)
.then(resized => {
canvacard.write(resized, "resized.png");
})
.catch(console.error);
```
### kiss(image1, image2) β `Promise.`
Kiss someone ( Ν‘Β° ΝΚ Ν‘Β°)
**Kind**: global function\
**Returns**: `Promise.` - Imagen de beso\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ------ | -------------------- | ------------ |
| image1 | `string` \| `Buffer` | First image |
| image2 | `string` \| `Buffer` | Second image |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.kiss("./image1.png", "./image2.png")
.then(kissed => {
canvacard.write(kissed, "kissed.png");
})
.catch(console.error);
```
### spank(image1, image2) β `Promise.`
To spank someone ( Ν‘Β° ΝΚ Ν‘Β°)
**Kind**: global function\
**Returns**: `Promise.` - Image of spank\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ------ | -------------------- | ------------ |
| image1 | `string` \| `Buffer` | First image |
| image2 | `string` \| `Buffer` | Second image |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.spank("./image1.png", "./image2.png")
.then(spanked => {
canvacard.write(spanked, "spanked.png");
})
.catch(console.error);
```
### slap(image1, image2) β `Promise.`
Slap someone ( Ν‘Β° ΝΚ Ν‘Β°)
**Kind**: global function\
**Returns**: `Promise.` - Image of slap\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ------ | -------------------- | ------------ |
| image1 | `string` \| `Buffer` | First image |
| image2 | `string` \| `Buffer` | Second image |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.slap("./image1.png", "./image2.png")
.then(slap => {
canvacard.write(slap, "slap.png");
})
.catch(console.error);
```
### facepalm(image) β `Promise.`
Facepalm someone
**Kind**: global function\
**Returns**: `Promise.` - Image of facepalm\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | ----------------- |
| image | `string` \| `Buffer` | Image to facepalm |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.facepalm("./image.png")
.then(facepalm => {
canvacard.write(facepalm, "facepalm.png");
})
.catch(console.error);
```
### colorfy(image, color) β `Promise.`
Colorfy an image
**Kind**: global function\
**Returns**: `Promise.` - Colorfied image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | --------------------------------- |
| image | `string` \| `Buffer` | Image to colorfy |
| color | `string` | Color to apply to the image (hex) |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.colorfy("./image.png", "#FF0000")
.then(colorfy => {
canvacard.write(colorfy, "colorfy.png");
})
.catch(console.error);
```
### distracted(image1, image2, image3) β `Promise.`
Distract someone
**Kind**: global function\
**Returns**: `Promise.` - Distracted image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ------ | -------------------- | ----------------------------------- |
| image1 | `string` \| `Buffer` | Face for the girl in red. |
| image2 | `string` \| `Buffer` | Face for the boy. |
| image3 | `string` \| `Buffer` | Face for the other girl \[optional] |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.distracted("./image1.png", "./image2.png", "./image3.png")
.then(distracted => {
canvacard.write(distracted, "distracted.png");
})
.catch(console.error);
```
### jail(image, greyscale) β `Promise.`
Create a jail image
**Kind**: global function\
**Returns**: `Promise.` - Jailed image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| --------- | -------------------- | -------------------------------- |
| image | `string` \| `Buffer` | Image to jail |
| greyscale | `boolean` | If the image should be greyscale |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.jail("./image.png")
.then(jail => {
canvacard.write(jail, "jail.png");
})
.catch(console.error);
```
### bed(image1, image2) β `Promise.`
Create a bed image
**Kind**: global function\
**Returns**: `Promise.` - Imagen de cama\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ------ | -------------------- | ------------ |
| image1 | `string` \| `Buffer` | First image |
| image2 | `string` \| `Buffer` | Second image |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.bed("./image1.png", "./image2.png")
.then(bed => {
canvacard.write(bed, "bed.png");
})
.catch(console.error);
```
### delete(image, dark) β `Promise.`
Create a deleted image
**Kind**: global function\
**Returns**: `Promise.` - Deleted image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | --------------------------- |
| image | `string` \| `Buffer` | Image to delete |
| dark | `boolean` | If the image should be dark |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.delete("./image.png")
.then(deleted => {
canvacard.write(deleted, "deleted.png");
})
.catch(console.error);
```
### gradient(colorFrom, colorTo, width, height) β `Promise.`
Create a gradient image
**Kind**: global function\
**Returns**: `Promise.` - Gradient image\
**Throws**:
* `APIError` If colorFrom or colorTo is not provided
| Param | Type | Description |
| --------- | -------- | --------------- |
| colorFrom | `string` | First color |
| colorTo | `string` | Second color |
| width | `number` | Width of image |
| height | `number` | Height of image |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.gradient("#FF0000", "#0000FF", 500, 500)
.then(gradient => {
canvacard.write(gradient, "gradient.png");
})
.catch(console.error);
```
### quote(options, \[font]) β `Promise.`
Create a fake quote image
**Kind**: global function\
**Returns**: `Promise.` - Quote image
| Param | Type | Default | Description |
| ------------------- | -------------------- | --------------------- | ---------------------- |
| options | `object` | | Options |
| \[options.image] | `Buffer` \| `string` | | Image |
| \[options.message] | `string` | | Message |
| \[options.username] | `string` | | Username |
| \[options.color] | `string` | | Color |
| \[font] | `string` | `""Arial""` | Text font for the card |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.quote({ image: "./image.png", message: "This is amazing!", username: "Clyde", color: "#FFFFFF" })
.then(quote => {
canvacard.write(quote, "quote.png");
})
.catch(console.error);
```
### phub(options, \[font]) β `Promise.`
PornHub Comment
**Kind**: global function\
**Returns**: `Promise.` - PornHub Comment image\
**Throws**:
* `APIError` If username, message or image is not provided
| Param | Type | Default | Description |
| ------------------- | -------------------- | --------------------- | ------------------ |
| options | `Object` | | Options |
| \[options.username] | `String` | | Username |
| \[options.message] | `String` | | Message |
| \[options.image] | `String` \| `Buffer` | | Image |
| \[font] | `string` | `""Arial""` | Text font for card |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.phub({ username: "Clyde", message: "This is amazing!", image: "./image.png" })
.then(phub => {
canvacard.write(phub, "phub.png");
})
.catch(console.error);
```
### wanted(image) β `Promise.`
Create a "wanted" image
**Kind**: global function\
**Returns**: `Promise.` - Wanted image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | --------------- |
| image | `string` \| `Buffer` | Image to wanted |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.wanted("./image.png")
.then(wanted => {
canvacard.write(wanted, "wanted.png");
})
.catch(console.error);
```
### wasted(image) β `Promise.`
Create a "wasted" image
**Kind**: global function\
**Returns**: `Promise.` - Wasted image\
**Throws**:
* `APIError` If image is not provided
| Param | Type | Description |
| ----- | -------------------- | --------------- |
| image | `string` \| `Buffer` | Image to wasted |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.wasted("./image.png")
.then(wasted => {
canvacard.write(wasted, "wasted.png");
})
.catch(console.error);
```
### youtube(ops) β `Promise.`
Create a YouTube comment image
**Kind**: global function\
**Returns**: `Promise.` - YouTube comment image\
**Throws**:
* `APIError` If username, content or avatar is not provided
| Param | Type | Default | Description |
| --------------- | -------------------- | ------- | ----------- |
| ops | `object` | | Options |
| \[ops.username] | `string` | | Username |
| \[ops.content] | `string` | | Content |
| \[ops.avatar] | `string` \| `Buffer` | | Avatar |
| \[ops.dark] | `boolean` | `false` | Dark mode |
**Example**
```js
const canvacard = require("canvacard");
canvacard.Canvas.youtube({ username: "Clyde", content: "This is amazing!", avatar: "./image.png" })
.then(youtube => {
canvacard.write(youtube, "youtube.png");
})
.catch(console.error);
```
### write(data, name) β `void`
Writes data as a file
**Kind**: global function
| Param | Type | Description |
| ----- | -------- | ------------- |
| data | `Buffer` | data to write |
| name | `string` | file name |
### reply(options) β `Promise.`
Discord Reply Clone
**Kind**: global function\
**Returns**: `Promise.` - Reply image\
**Throws**:
* `APIError` If the avatar, username or message is not provided
| Param | Type | Description |
| -------------------- | -------------------- | --------------------------------------------- |
| options | `object` | Options |
| \[options.avatar1] | `string` \| `Buffer` | Avatar of the person who responded |
| \[options.avatar2] | `string` \| `Buffer` | Avatar of the other person |
| \[options.user1] | `string` | Username of the person who responded |
| \[options.user2] | `string` | Username of the other person |
| \[options.hex1] | `string` | Hexadecimal color of the person who responded |
| \[options.hex2] | `string` | Hexadecimal color of the other person |
| \[options.mainText] | `string` | Message of the person who responded |
| \[options.replyText] | `string` | Message of the other person |
**Example**
```js
const img = "https://cdn.discordapp.com/embed/avatars/0.png";
const img2 = "https://cdn.discordapp.com/embed/avatars/4.png";
canvacard.Canvas.reply({
avatar1: img,
avatar2: img2,
user1: "Maximus",
user2: "SrGobi",
hex1: "#FF3300",
hex2: "#7289da",
mainText: "kok",
replyText: "Pog"
})
.then(img => canvacard.write(img, "reply.png"));
```
# Spotify
### Classes
[Spotify](#Spotify)
### Functions
[setProgressBar(type, color)](#setProgressBar) β [`Spotify`](#Spotify)
Set progress bar details
[setTitle(title)](#setTitle) β [`Spotify`](#Spotify)
Set title
[setImage(source)](#setImage) β [`Spotify`](#Spotify)
Establecer imagen
[setAuthor(name)](#setAuthor) β [`Spotify`](#Spotify)
Set the name of the artist
[setAlbum(name)](#setAlbum) β [`Spotify`](#Spotify)
Set the name of the album
[setStartTimestamp(time)](#setStartTimestamp) β [`Spotify`](#Spotify)
Set start timestamp
[setEndTimestamp(time)](#setEndTimestamp) β [`Spotify`](#Spotify)
Set end timestamp
[setBackground(type, data)](#setBackground) β [`Spotify`](#Spotify)
Set background image/color of the card
[build(\[font\])](#build) β `Promise.`
Build the Spotify presence card
### Spotify
**Kind**: global class
#### new Spotify()
Spotify card creator
PREVIEW
\
**Example**
```js
const spotify = new canvacard.Spotify()
.setAuthor("SAIKO")
.setAlbum("SAKURA π")
.setStartTimestamp(Date.now() - 10000)
.setEndTimestamp(Date.now() + 50000)
.setImage("https://i.scdn.co/image/ab67616d00001e02e346fc6f767ca2ac8365fe60")
.setTitle("YO LO SOΓΓ");
const spotifyImage = await spotify.build("Cascadia Code PL");
canvacard.write(spotifyImage, "./spotify.png");
```
### setProgressBar(type, color) β [`Spotify`](#Spotify)
Set progress bar details
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Invalid progress bar type
| Param | Type | Description |
| ----- | -------------------- | ------------------------- |
| type | `"TRACK"` \| `"BAR"` | Type of progress bar |
| color | `string` | Color of the progress bar |
### setTitle(title) β [`Spotify`](#Spotify)
Set title
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Title expected but not received
| Param | Type | Description |
| ----- | -------- | ----------------- |
| title | `string` | Title of the song |
### setImage(source) β [`Spotify`](#Spotify)
Establecer imagen
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Image source expected but not received
| Param | Type | Description |
| ------ | -------------------------------------- | ---------------- |
| source | `string` \| `Buffer` \| `Canvas.Image` | Fuente de imagen |
### setAuthor(name) β [`Spotify`](#Spotify)
Set the name of the artist
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Artist name expected but not received
| Param | Type | Description |
| ----- | -------- | ------------------ |
| name | `string` | Name of the artist |
### setAlbum(name) β [`Spotify`](#Spotify)
Set the name of the album
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Album name expected but not received
| Param | Type | Description |
| ----- | -------- | ----------------- |
| name | `string` | Name of the album |
### setStartTimestamp(time) β [`Spotify`](#Spotify)
Set start timestamp
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Timestamp expected but not received
| Param | Type | Description |
| ----- | ------------------ | ----------- |
| time | `Date` \| `number` | Timestamp |
### setEndTimestamp(time) β [`Spotify`](#Spotify)
Set end timestamp
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Timestamp expected but not received
| Param | Type | Description |
| ----- | ------------------ | ----------- |
| time | `Date` \| `number` | Timestamp |
### setBackground(type, data) β [`Spotify`](#Spotify)
Set background image/color of the card
**Kind**: global function\
**Returns**: [`Spotify`](#Spotify) - The current instance of Spotify\
**Throws**:
* `APIError` Missing background data
| Param | Type | Description |
| ----- | -------------------------------------- | ---------------------------- |
| type | `"COLOR"` \| `"IMAGE"` | Type of background |
| data | `string` \| `Buffer` \| `Canvas.Image` | Image URL or HTML color code |
### build(\[font]) β `Promise.`
Build the Spotify presence card
**Kind**: global function\
**Returns**: `Promise.` - Card image in buffer format\
**Throws**:
* `APIError` Missing of options
| Param | Type | Default | Description |
| ------- | -------- | --------------------- | ----------------------- |
| \[font] | `string` | `""Arial""` | Font to use in the card |
# Rank
### Classes
[Rank](#Rank)
### Functions
[setAvatar(avatarUrl, AvatarDecorationData, squareAvatar)](#setAvatar) β [`Rank`](#Rank)
Set the user avatar
[setBanner(bannerUrl, moreBackgroundBlur, disableBackgroundBlur, backgroundBrightness)](#setBanner) β [`Rank`](#Rank)
Set the user banner
[setBadges(flags, bot, frame, customBadges)](#setBadges) β [`Rank`](#Rank)
Set the user badges and frame
[setBorder(color, allign)](#setBorder) β [`Rank`](#Rank)
Set the border of the card
[setUsername(name, \[discriminator\], \[color\], \[customUsername\], \[customTag\])](#setUsername) β [`Rank`](#Rank)
Set the username of the user
[setCurrentXP(data, \[color\])](#setCurrentXP) β [`Rank`](#Rank)
Set the current experience
[setRequiredXP(data, \[color\])](#setRequiredXP) β [`Rank`](#Rank)
Set the required experience
[setRank(data, \[text\], \[display\])](#setRank) β [`Rank`](#Rank)
Set the user rank
[setLevel(data, \[text\])](#setLevel) β [`Rank`](#Rank)
Establece el nivel del usuario
[setProgressBar(color, \[fillType\], \[rounded\])](#setProgressBar) β [`Rank`](#Rank)
Set the progress bar
[setStatus(presenceStatus)](#setStatus) β [`Rank`](#Rank)
Set the user presence status
[setCreatedTimestamp(timestamp, customDate)](#setCreatedTimestamp) β [`Rank`](#Rank)
Set the user created timestamp
[build(\[font\])](#build) β `Promise.`
Build the rank card
### Rank
**Kind**: global class
#### new Rank(userId)
Rank card creator
PREVIEW
\
  
| Param | Type | Description |
| ------ | -------- | ----------- |
| userId | `string` | User ID |
**Example**
```js
const rank = new canvacard.Rank(data.id)
.setAvatar(data.avatarURL, data.avatar_decoration_data.asset)
.setBanner(data.bannerURL, true)
.setBadges(data.flags, data.bot, true)
.setBorder(["#22274a", "#001eff"], "vertical")
.setCurrentXP(userData.xp)
.setRequiredXP(userData.requiredXP)
.setRank(1, "RANK", true)
.setLevel(20, "LEVEL", true)
.setStatus("online")
.setProgressBar(["#14C49E", "#FF0000"], "GRADIENT", true)
.setUsername(data.global_name, data.discriminator)
.setCreatedTimestamp(data.createdTimestamp);
const rankImage = await rank.build("Cascadia Code PL");
canvacard.write(rankImage, "./rank.png");
```
### setAvatar(avatarUrl, AvatarDecorationData, squareAvatar) β [`Rank`](#Rank)
Set the user avatar
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Description |
| -------------------- | --------- | ----------------------- |
| avatarUrl | `string` | Avatar URL |
| AvatarDecorationData | `string` | Avatar decoration asset |
| squareAvatar | `boolean` | Square avatar |
### setBanner(bannerUrl, moreBackgroundBlur, disableBackgroundBlur, backgroundBrightness) β [`Rank`](#Rank)
Set the user banner
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Description |
| --------------------- | --------- | ----------------------- |
| bannerUrl | `string` | Banner URL |
| moreBackgroundBlur | `boolean` | More background blur |
| disableBackgroundBlur | `boolean` | Disable background blur |
| backgroundBrightness | `number` | Background brightness |
### setBadges(flags, bot, frame, customBadges) β [`Rank`](#Rank)
Set the user badges and frame
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Description |
| ------------ | ---------------- | -------------------------------- |
| flags | `number` | User flags |
| bot | `boolean` | Whether the user is a bot or not |
| frame | `boolean` | Badge frame |
| customBadges | `Array.` | Custom badges |
### setBorder(color, allign) β [`Rank`](#Rank)
Set the border of the card
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Description |
| ------ | ---------------------------- | ------------------------------------------------------------- |
| color | `string` \| `Array.` | HEX color of the border, can be gradient if 2 colors are used |
| allign | `string` | Gradient alignment if 2 colors are used |
### setUsername(name, \[discriminator], \[color], \[customUsername], \[customTag]) β [`Rank`](#Rank)
Set the username of the user
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Default | Description |
| ----------------- | -------- | ----------------------- | ------------------------- |
| name | `string` | | Username of the user |
| \[discriminator] | `string` | `""0""` | Discriminator of the user |
| \[color] | `string` | `""#FFFFFF""` | Color of the username |
| \[customUsername] | `string` | `null` | Custom username |
| \[customTag] | `string` | `null` | Custom tag |
### setCurrentXP(data, \[color]) β [`Rank`](#Rank)
Set the current experience
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Default | Description |
| -------- | -------- | ----------------------- | ----------------------- |
| data | `number` | | Current experience data |
| \[color] | `string` | `""#FFFFFF""` | Text color |
### setRequiredXP(data, \[color]) β [`Rank`](#Rank)
Set the required experience
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Default | Description |
| -------- | -------- | ----------------------- | ------------------------ |
| data | `number` | | Required experience data |
| \[color] | `string` | `""#FFFFFF""` | Text color |
### setRank(data, \[text], \[display]) β [`Rank`](#Rank)
Set the user rank
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Default | Description |
| ---------- | --------- | -------------------- | -------------------------- |
| data | `number` | | Rank data |
| \[text] | `string` | `""RANK""` | Display text |
| \[display] | `boolean` | `false` | Display system rank or not |
### setLevel(data, \[text]) β [`Rank`](#Rank)
Establece el nivel del usuario
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Default | Description |
| ------- | -------- | --------------------- | ------------ |
| data | `number` | | Level data |
| \[text] | `string` | `""LEVEL""` | Display text |
### setProgressBar(color, \[fillType], \[rounded]) β [`Rank`](#Rank)
Set the progress bar
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Default | Description |
| ----------- | ---------------------------- | --------------------- | --------------------------------------------------------------- |
| color | `string` \| `Array.` | | Color of the progress bar, can be gradient if 2 colors are used |
| \[fillType] | `string` | `""COLOR""` | Type of progress bar |
| \[rounded] | `boolean` | `true` | Rounded corners of the progress bar |
### setStatus(presenceStatus) β [`Rank`](#Rank)
Set the user presence status
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Description |
| -------------- | -------- | --------------- |
| presenceStatus | `string` | Presence status |
### setCreatedTimestamp(timestamp, customDate) β [`Rank`](#Rank)
Set the user created timestamp
**Kind**: global function\
**Returns**: [`Rank`](#Rank) - The current instance of Rank\
**Throws**:
* `APIError` If the URL or asset is invalid
| Param | Type | Description |
| ---------- | ------------------ | ----------------------------------------- |
| timestamp | `number` | Timestamp of when the user joined Discord |
| customDate | `string` \| `Date` | Custom date format for the timestamp |
### build(\[font]) β `Promise.`
Build the rank card
**Kind**: global function\
**Returns**: `Promise.` - Card image in buffer format\
**Throws**:
* `APIError` Missing field: data
| Param | Type | Default | Description |
| ------- | -------- | --------------------- | ----------------------- |
| \[font] | `string` | `""Arial""` | Font to use in the card |
# Plugins
### Plugins : `object`
**Kind**: global typedef\
**Properties**
| Name | Type | Description |
| --------- | ---------- | --------------------------- |
| circle | `function` | Complement of circle |
| convolute | `function` | Convolute complement |
| abbrev | `function` | Complement of abbreviations |
# Utils
# Abbreviate
### Members
[getFirstDigitsAsDecimal](#getFirstDigitsAsDecimal)
This method takes a large number like "9360" and converts it to a small decimal like "9.3". Used by `abbreviateNumber()` to form abbreviations such as "9.3K". For the moment, this method intentionally avoids rounding numbers for simplicity.
### Functions
[abbreviateNumber()](#abbreviateNumber)
The abbreviation follows the format seen in many games: K - thousands M - millions B - billons T - trillons
All numbers greater than billions follow the following format, using each letter of the alphabet paired with itself: AA BB ... ZZ
It supports all numbers up to almost a googol (100 zeros) and supports up to 92 zeros or 93 digits.
### getFirstDigitsAsDecimal
This method takes a large number like "9360" and converts it to a small decimal like "9.3". Used by `abbreviateNumber()` to form abbreviations such as "9.3K". For the moment, this method intentionally avoids rounding numbers for simplicity.
**Kind**: global variable
### abbreviateNumber()
The abbreviation follows the format seen in many games: K - thousands M - millions B - billons T - trillons
All numbers greater than billions follow the following format, using each letter of the alphabet paired with itself: AA BB ... ZZ
It supports all numbers up to almost a googol (100 zeros) and supports up to 92 zeros or 93 digits.
**Kind**: global function
# Canvas
### Members
[generateBadgesCanvas](#generateBadgesCanvas) β `Promise.`
Generate the badge canvas
[genBase](#genBase) β `Promise.`
Generate the card background
[genFrame](#genFrame) β `Promise.`
Generate the card frame
[genBorder](#genBorder) β `Promise.`
Generate the edges of the card with a multi-color gradient
[genTextAndAvatar](#genTextAndAvatar) β `Promise.`
Generate the card text and avatar
[genAvatarFrame](#genAvatarFrame) β `Promise.`
This function generates the avatar frame
[cutAvatarStatus](#cutAvatarStatus) β `Promise.`
This function cuts the presence status on the card
[genStatus](#genStatus) β `Promise.`
Sets the presence status on the card
[genBotVerifBadge](#genBotVerifBadge) β `Promise.`
Generate the bot verification badge
[addShadow](#addShadow) β `Promise.`
Shadows for the canvas
### Functions
[genXpBar(options)](#genXpBar) β `Promise.`
Generate the experience bar
### generateBadgesCanvas β `Promise.`
Generate the badge canvas
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| ----------------------- | ---------------- | -------------------- |
| user | `Object` | User object |
| user.bot | `string` | If the user is a bot |
| user.id | `string` | User ID |
| user.flags | `Object` | User Badges |
| user.discriminator | `string` | User Discriminator |
| options | `Object` | Object of options |
| options.customBadges | `Array.` | Custom Badges |
| options.overwriteBadges | `boolean` | Overwrite the badges |
### genBase β `Promise.`
Generate the card background
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| ---------- | -------- | ----------------- |
| options | `Object` | Object of options |
| avatarData | `string` | Avatar URL |
| bannerData | `string` | Banner URL |
### genFrame β `Promise.`
Generate the card frame
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type |
| ----------------------- | -------------- |
| badgesData | `Object` |
| badgesData.canvas | `CanvasElemet` |
| badgesData.badgesLength | `string` |
| options | `Object` |
| options.badgesFrame | `string` |
### genBorder β `Promise.`
Generate the edges of the card with a multi-color gradient
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| -------------------- | ---------------------------- | ------------------------------------------- |
| options | `Object` | Options object |
| options.borderColor | `string` \| `Array.` | It can be a color or an array of colors |
| options.borderAllign | `string` | Edge direction ('vertical' or 'horizontal') |
### genTextAndAvatar β `Promise.`
Generate the card text and avatar
**Kind**: global variable
| Param | Type | Default | Description |
| ---------------------- | ------------------ | --------------------- | -------------------------------------------- |
| user | `Object` | | User data |
| user.username | `string` | | User name |
| user.discriminator | `string` | | User discriminator |
| user.bot | `boolean` | | If the user is a bot |
| user.createdTimestamp | `number` | | User creation timestamp |
| user.id | `string` | | User ID |
| options | `Object` | | Options object |
| options.customUsername | `string` | | Custom username |
| options.usernameColor | `string` | | Username color |
| options.customSubtitle | `string` | | Custom subtitle |
| options.subtitleColor | `string` | | Subtitle color |
| options.customDate | `string` \| `Date` | | Custom date |
| options.localDateType | `string` | | Local format for the date, for example, 'en' |
| options.customTag | `string` | | Custom tag |
| options.tagColor | `string` | | HEX Color of the label |
| options.squareAvatar | `boolean` | | Change the shape of the avatar to a square |
| options.presenceStatus | `boolean` | | Show presence status |
| rankData | `Object` | | Range data |
| avatarData | `string` | | Avatar URL |
| \[font] | `string` | `""Arial""` | Typeface family |
### genAvatarFrame β `Promise.`
This function generates the avatar frame
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| ----------------------------------- | -------- | ----------------------- |
| user | `Object` | User data |
| user.avatar\_decoration\_data | `Object` | Avatar decoration data |
| user.avatar\_decoration\_data.asset | `string` | Avatar decoration asset |
| options | `Object` | Object of options |
| options.presenceStatus | `string` | User presence |
### cutAvatarStatus β `Promise.`
This function cuts the presence status on the card
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| ---------------------- | ------------------- | ----------------------- |
| canvasToEdit | `Image` \| `Canvas` | Image or canvas to edit |
| options | `Object` | Object of options |
| options.presenceStatus | `string` | User presence |
### genStatus β `Promise.`
Sets the presence status on the card
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| ---------------------- | ------------------- | ----------------------- |
| canvasToEdit | `Image` \| `Canvas` | Image or canvas to edit |
| options | `Object` | Object of options |
| options.presenceStatus | `string` | User presence |
### genBotVerifBadge β `Promise.`
Generate the bot verification badge
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Default | Description |
| ------------- | -------- | --------------------- | ------------------------------- |
| user | `Object` | | User object |
| user.username | `string` | | User name |
| user.flags | `number` | | Numeric value of the user flags |
| \[font] | `string` | `""Arial""` | Typeface family |
### addShadow β `Promise.`
Shadows for the canvas
**Kind**: global variable\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| ------------ | ------------------- | ----------------------- |
| canvasToEdit | `Image` \| `Canvas` | Image or canvas to edit |
### genXpBar(options) β `Promise.`
Generate the experience bar
**Kind**: global function\
**Returns**: `Promise.` - Canvas
| Param | Type | Description |
| ------------------------------ | ---------------------------- | ---------------------------- |
| options | `Object` | Options object |
| options.rankData | `Object` | Rank data |
| options.rankData.currentXp | `number` | User current XP |
| options.rankData.requiredXp | `number` | XP required to level up |
| options.rankData.level | `number` | User level |
| options.rankData.rank | `number` | User rank |
| options.rankData.barColor | `string` \| `Array.` | Color of the XP bar |
| options.rankData.levelColor | `string` | Color of the level text |
| options.rankData.autoColorRank | `boolean` | Automatically color the rank |
# Discord Time
### discordTime β `string`
Convert regular timestamp to Discord-like time.
**Kind**: global variable\
**Returns**: `string` - Discord-like time chain
| Param | Type | Description |
| ----- | ------------------ | -------------------- |
| time | `Date` \| `number` | Timestamp to convert |
# Error
### APIError β `Error`
Error class for API errors
**Kind**: global class\
**Extends**: `Error`
#### new APIError(message)
APIError class
**Returns**: [`APIError`](#APIError) - APIError object
| Param | Type | Description |
| ------- | -------- | ------------- |
| message | `string` | Error message |
# Flags
### checkFlags β `Array.`
Function to check flags and get the badges.
**Kind**: global variable\
**Returns**: `Array.` - Badges array
| Param | Type | Description |
| ---------- | -------------------- | ------------- |
| flags | `Object` | Badges object |
| flagNumber | `BigInt` \| `string` | Badges number |
# Format and Validate Hex
### formatAndValidateHex β `string`
Formats and validates the hexadecimal code.
**Kind**: global variable\
**Returns**: `string` - Formatted and validated hexadecimal code
| Param | Type | Description |
| ----- | -------- | ---------------------------------------------- |
| hex | `string` | Hexadecimal code for formatting and validation |
| alt | `string` | Alternative color if code is invalid |
# Format Time
### formatTime β `string`
Formats the timestamp into a date string.
**Returns**: `string` - Formatted date string
| Param | Type | Description |
| ----- | -------- | -------------------- |
| time | `number` | Timestamp to convert |
# Format Variable
### formatVariable β `string`
Gets variables and types.
**Kind**: global variable\
**Returns**: `string` - The formatted variable
| Param | Type | Description |
| -------- | -------- | ---------------------- |
| prefix | `object` | The type of variable |
| variable | `object` | The variable to change |
# Get Date or String
### getDateOrString β `string`
Gets a formatted date string or returns the input as is.
**Kind**: global variable\
**Returns**: `string` - The formatted date string or the original input.
| Param | Type | Default | Description |
| ---------------- | ------------------ | -------- | --------------------------------------------------------------------- |
| dateInput | `string` \| `Date` | | The date to format. Can be a date string (ISO 8601) or a Date object. |
| createdTimestamp | `number` | | A fallback timestamp to use if dateInput is undefined or null. |
| \[localDateType] | `string` | `"'en'"` | The locale for the date format (default is English). |
# Icon
### getIconPath β `string`
Function to get the URL of a badge icon. If the icon is a relative path, it is transformed into an absolute URL pointing to the GitHub repository.
**Kind**: global variable\
**Returns**: `string` - Absolute URL of the icon.\
**Throws**:
* `APIError` If there is a problem building the icon URL.
| Param | Type | Description |
| ------- | -------- | ---------------------- |
| iconUrl | `string` | Icon name or icon URL. |
# Is Number
### isNumber β `number`
Checks if the parameter is a number
**Kind**: global variable\
**Returns**: `number` - Parameter
| Param | Type | Description |
| ----- | -------- | ------------------ |
| param | `number` | Parameter to check |
| type | `string` | Parameter type |
# Is String
### isString β `string`
Checks if the parameter is a string
**Kind**: global variable\
**Returns**: `string` - Parameter
| Param | Type | Description |
| ----- | -------- | ------------------ |
| param | `string` | Parameter to check |
| type | `string` | Parameter type |
# Parse Image
### parseImg β `string`
Check if the custom badge is valid
**Kind**: global variable\
**Returns**: `string` - Image URL
| Param | Type | Description |
| -------------- | -------- | ----------- |
| imgStringImage | `string` | image URL |
# Parse PNG
### parsePng β `string`
Check if the custom badge is valid
**Kind**: global variable\
**Returns**: `string` - Image URL
| Param | Type | Description |
| --------- | -------- | ----------- |
| imgString | `string` | Image URL |
# Parse SVG
### Members
[parseSvg](#parseSvg) β `string`
Check if the custom badge is valid (SVG)
[validateImage](#validateImage) β `string`
Helper function to validate images
### parseSvg β `string`
Check if the custom badge is valid (SVG)
**Kind**: global variable\
**Returns**: `string` - Image URL
| Param | Type | Description |
| --------- | -------- | ----------- |
| imgString | `string` | Image URL |
### validateImage β `string`
Helper function to validate images
**Kind**: global variable\
**Returns**: `string` - Image URL
| Param | Type | Description |
| --------- | -------- | --------------------------------- |
| imgString | `string` | Image URL |
| format | `string` | Image format ('png', 'svg', etc.) |
# Shorten
### shorten β `string`
Shorten text to a specific length and add ellipses if necessary.
**Kind**: global variable\
**Returns**: `string` - Original or shortened text
| Param | Type | Description |
| ----- | -------- | ---------------------------------------- |
| text | `string` | Text to be shortened |
| len | `number` | Maximum length of text before shortening |
# Truncate Text
### truncateText β `string`
Truncates text to a specified length and adds an ellipsis if necessary.
**Kind**: global variable\
**Returns**: `string` - The original or truncated text.
| Param | Type | Default | Description |
| ---------- | --------- | ------- | ---------------------------------------------------------------------------------- |
| text | `string` | | The text to be truncated. |
| \[limit] | `number` | `25` | The maximum length of text before truncation (default is 25). |
| \[fromEnd] | `boolean` | `false` | If true, truncation will be performed from the end of the text (default is false). |
# Username
### parseUsername β `Object`
Function that parses the username to fit the canvas size.
**Kind**: global variable\
**Returns**: `Object` - { username: string, newSize: number, textLength: number }
| Param | Type | Default | Description |
| --------------- | ------------- | ----------- | ------------------- |
| username | `string` | | User name |
| ctx | `Object` | | Canvas context |
| ctx.fillStyle | `string` | | Text color |
| ctx.textAlign | `string` | | Text alignment |
| ctx.measureText | `TextMetrics` | | Text size |
| \[font] | `string` | `"'Arial'"` | Text source |
| size | `string` | | Text size |
| maxLength | `number` | | Maximum text length |