From 12c1e2dde79313fde0580854abb10206444de335 Mon Sep 17 00:00:00 2001 From: SrGobi Date: Wed, 23 Oct 2024 12:42:21 +0200 Subject: [PATCH] feat: Actualizar clases Se actualizaron las funciones en la clases para establecer los metodos indicando los nombres, descripciones y demas datos necesarios para cada una de las clases. --- Classes/Canvacard.md | 434 ++++++++++++++++++++-------------------- Classes/FortniteShop.md | 54 +++-- Classes/Rank.md | 208 ++++++++++--------- Classes/Spotify.md | 259 ++++++++++-------------- 4 files changed, 472 insertions(+), 483 deletions(-) diff --git a/Classes/Canvacard.md b/Classes/Canvacard.md index e818c60..41c3bdc 100644 --- a/Classes/Canvacard.md +++ b/Classes/Canvacard.md @@ -1,65 +1,104 @@ -## Classes +## Functions
-
Canvacard
-

Canvacard Generador De Memes

+
trigger(image) ⇒ Promise.<Buffer>
+

Este método se puede utilizar para aplicar el efecto Disparado en la imagen.

-
- -## Typedefs - -
-
ConvolutionMatrix : object
-

Matriz de convolución Canvacard

+
invert(image) ⇒ Promise.<Buffer>
+

Invierte el color de la imagen

+
+
sepia(image) ⇒ Promise.<Buffer>
+

Aplicar lavado sepia en img

+
+
greyscale(image) ⇒ Promise.<Buffer>
+

Efecto de escala de grises sobre la imagen

+
+
brightness(image, amount) ⇒ Promise.<Buffer>
+

Editar el brillo de la imagen

+
+
darkness(image, amount) ⇒ Promise.<Buffer>
+

Editar la oscuridad de la imagen

+
+
threshold(img, amount) ⇒ Promise.<Buffer>
+
+
convolute(img, matrix, opaque) ⇒ Promise.<Buffer>
+

Convolución de la imagen

+
+
pixelate(image, pixels) ⇒ Promise.<Buffer>
+

Pixelar

+
+
sharpen(image, lvl) ⇒ Promise.<Buffer>
+

Agudizar una imagen

+
+
burn(image, lvl) ⇒ Promise.<Buffer>
+

Aplica efecto de quemado en una imagen.

+
+
circle(image) ⇒ Promise.<Buffer>
+

Crea una imagen circular

+
+
fuse(image1, image2) ⇒ Promise.<Buffer>
+

Fusiona dos imágenes

+
+
resize(image, width, height) ⇒ Promise.<Buffer>
+

Cambiar el tamaño de una imagen

+
+
kiss(image1, image2) ⇒ Promise.<Buffer>
+

Besarse ( ͡° ͜ʖ ͡°)

+
+
spank(image1, image2) ⇒ Promise.<Buffer>
+

Azotar a alguien ( ͡° ͜ʖ ͡°)

+
+
slap(image1, image2) ⇒ Promise.<Buffer>
+

Abofetear a alguien ( ͡° ͜ʖ ͡°)

+
+
facepalm(image) ⇒ Promise.<Buffer>
+

Hacer una imagen de palma en la cara

+
+
colorfy(image, color) ⇒ Promise.<Buffer>
+

Actualiza el color de la imagen

+
+
distracted(image1, image2, image3) ⇒ Promise.<Buffer>
+

Crear una imagen de meme de distracción

+
+
jail(image, greyscale) ⇒ Promise.<Buffer>
+

Crear una imagen de celda

+
+
bed(image1, image2) ⇒ Promise.<Buffer>
+

Crear una imagen de cama

+
+
delete(image, dark) ⇒ Promise.<Buffer>
+

Crear una imagen eliminada

+
+
gradient(colorFrom, colorTo, width, height) ⇒ Promise.<Buffer>
+

Crear una imagen degradada

+
+
quote(options, [font]) ⇒ Promise.<Buffer>
+

Crear una imagen de cita falsa

+
+
phub(options, [font]) ⇒ Promise.<Buffer>
+

Comentario de PornHub

+
+
wanted(image) ⇒ Promise.<Buffer>
+

Crear una imagen de se busca

+
+
wasted(image) ⇒ Promise.<Buffer>
+

Crear una imagen de "wasted"

+
+
youtube(ops) ⇒ Promise.<Buffer>
+

Comentario de YouTube

+
+
write(data, name) ⇒ void
+

Escribe los datos como archivo

+
+
reply(options) ⇒ Promise.<Buffer>
+

Clon de respuesta de discord

## Canvacard -Canvacard Generador De Memes - -**Kind**: global class - -* [Canvacard](#Canvacard) - * [new Canvacard()](#new_Canvacard_new) - * [.CONVOLUTION_MATRIX](#Canvacard.CONVOLUTION_MATRIX) : [ConvolutionMatrix](#ConvolutionMatrix) - * [.trigger(image)](#Canvacard.trigger) ⇒ Promise.<Buffer> - * [.invert(image)](#Canvacard.invert) ⇒ Promise.<Buffer> - * [.sepia(image)](#Canvacard.sepia) ⇒ Promise.<Buffer> - * [.greyscale(image)](#Canvacard.greyscale) ⇒ Promise.<Buffer> - * [.brightness(image, amount)](#Canvacard.brightness) ⇒ Promise.<Buffer> - * [.darkness(image, amount)](#Canvacard.darkness) ⇒ Promise.<Buffer> - * [.threshold(img, amount)](#Canvacard.threshold) ⇒ Promise.<Buffer> - * [.convolute(img, matrix, opaque)](#Canvacard.convolute) ⇒ Promise.<Buffer> - * [.pixelate(image, pixels)](#Canvacard.pixelate) ⇒ Promise.<Buffer> - * [.sharpen(image, lvl)](#Canvacard.sharpen) ⇒ Promise.<Buffer> - * [.burn(image, lvl)](#Canvacard.burn) ⇒ Promise.<Buffer> - * [.circle(image)](#Canvacard.circle) ⇒ Promise.<Buffer> - * [.fuse(image1, image2)](#Canvacard.fuse) ⇒ Promise.<Buffer> - * [.resize(image, width, height)](#Canvacard.resize) ⇒ Promise.<Buffer> - * [.kiss(image1, image2)](#Canvacard.kiss) ⇒ Promise.<Buffer> - * [.spank(image1, image2)](#Canvacard.spank) ⇒ Promise.<Buffer> - * [.slap(image1, image2)](#Canvacard.slap) ⇒ Promise.<Buffer> - * [.facepalm(image)](#Canvacard.facepalm) ⇒ Promise.<Buffer> - * [.colorfy(image, color)](#Canvacard.colorfy) ⇒ Promise.<Buffer> - * [.distracted(image1, image2, image3)](#Canvacard.distracted) ⇒ Promise.<Buffer> - * [.jail(image, greyscale)](#Canvacard.jail) ⇒ Promise.<Buffer> - * [.bed(image1, image2)](#Canvacard.bed) ⇒ Promise.<Buffer> - * [.delete(image, dark)](#Canvacard.delete) ⇒ Promise.<Buffer> - * [.gradient(colorFrom, colorTo, width, height)](#Canvacard.gradient) ⇒ Promise.<Buffer> - * [.quote(options, [font])](#Canvacard.quote) ⇒ Promise.<Buffer> - * [.phub(options, [font])](#Canvacard.phub) ⇒ Promise.<Buffer> - * [.wanted(image)](#Canvacard.wanted) ⇒ Promise.<Buffer> - * [.wasted(image)](#Canvacard.wasted) ⇒ Promise.<Buffer> - * [.youtube(ops)](#Canvacard.youtube) ⇒ Promise.<Buffer> - * [.write(data, name)](#Canvacard.write) ⇒ void - * [.reply(options)](#Canvacard.reply) ⇒ Promise.<Buffer> - * [.__wait(dur)](#Canvacard.__wait) ⇒ Promise.<void> - - - -### new Canvacard() +**Kind**: global class Canvacard Generador De Memes **Example** ```js const canvacard = require("canvacard"); @@ -68,18 +107,12 @@ Canvacard Generador De Memes canvacard.write(triggered, "triggered.gif"); }) .catch(console.error); ``` - - -### Canvacard.CONVOLUTION\_MATRIX : [ConvolutionMatrix](#ConvolutionMatrix) -Datos de matriz para **Canvacard.convolute()** + -**Kind**: static property of [Canvacard](#Canvacard) - - -### Canvacard.trigger(image) ⇒ Promise.<Buffer> +## trigger(image) ⇒ Promise.<Buffer> Este método se puede utilizar para aplicar el efecto Disparado en la imagen. -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen "triggered" **Throws**: @@ -98,12 +131,12 @@ Este método se puede utilizar para aplicar el efecto Disparado en la imagen. canvacard.write(triggered, "triggered.gif"); }) .catch(console.error); ``` - + -### Canvacard.invert(image) ⇒ Promise.<Buffer> +## invert(image) ⇒ Promise.<Buffer> Invierte el color de la imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen invertida **Throws**: @@ -122,12 +155,12 @@ Invierte el color de la imagen canvacard.write(inverted, "inverted.png"); }) .catch(console.error); ``` - + -### Canvacard.sepia(image) ⇒ Promise.<Buffer> +## sepia(image) ⇒ Promise.<Buffer> Aplicar lavado sepia en img -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen sep **Throws**: @@ -146,12 +179,12 @@ Aplicar lavado sepia en img canvacard.write(sepia, "sepia.png"); }) .catch(console.error); ``` - + -### Canvacard.greyscale(image) ⇒ Promise.<Buffer> +## greyscale(image) ⇒ Promise.<Buffer> Efecto de escala de grises sobre la imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen en escala de grises **Throws**: @@ -170,12 +203,12 @@ Efecto de escala de grises sobre la imagen canvacard.write(greyscale, "greyscale.png"); }) .catch(console.error); ``` - + -### Canvacard.brightness(image, amount) ⇒ Promise.<Buffer> +## brightness(image, amount) ⇒ Promise.<Buffer> Editar el brillo de la imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen con brillo **Throws**: @@ -195,12 +228,12 @@ Editar el brillo de la imagen canvacard.write(brightened, "brightened.png"); }) .catch(console.error); ``` - + -### Canvacard.darkness(image, amount) ⇒ Promise.<Buffer> +## darkness(image, amount) ⇒ Promise.<Buffer> Editar la oscuridad de la imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen oscura **Throws**: @@ -220,17 +253,16 @@ Editar la oscuridad de la imagen canvacard.write(darkened, "darkened.png"); }) .catch(console.error); ``` - - -### Canvacard.threshold(img, amount) ⇒ Promise.<Buffer> -Umbral de imagen + -**Kind**: static method of [Canvacard](#Canvacard) +## threshold(img, amount) ⇒ Promise.<Buffer> +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen umbralizada **Throws**: - APIError Si no se proporciona la imagen o la cantidad no es un número +**Descrioption**: Umbral de imagen | Param | Type | Description | | --- | --- | --- | @@ -245,12 +277,12 @@ Umbral de imagen canvacard.write(thresholded, "thresholded.png"); }) .catch(console.error); ``` - + -### Canvacard.convolute(img, matrix, opaque) ⇒ Promise.<Buffer> +## convolute(img, matrix, opaque) ⇒ Promise.<Buffer> Convolución de la imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen convolucionada **Throws**: @@ -272,22 +304,22 @@ Convolución de la imagen canvacard.write(convoluted, "convoluted.png"); }) .catch(console.error); ``` - + -### Canvacard.pixelate(image, pixels) ⇒ Promise.<Buffer> +## pixelate(image, pixels) ⇒ Promise.<Buffer> Pixelar -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen pixelada **Throws**: - APIError Si no se proporciona la imagen o los píxeles no son un número -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| image | string \| Buffer | | Imagen para pixelar | -| pixels | number | 5 | Pixeles | +| Param | Type | Description | +| --- | --- | --- | +| image | string \| Buffer | Imagen para pixelar | +| pixels | number | Pixeles | **Example** ```js @@ -297,22 +329,22 @@ Pixelar canvacard.write(pixelated, "pixelated.png"); }) .catch(console.error); - + -### Canvacard.sharpen(image, lvl) ⇒ Promise.<Buffer> +## sharpen(image, lvl) ⇒ Promise.<Buffer> Agudizar una imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen enfocada **Throws**: - APIError Si no se proporciona la imagen o el nivel no es un número -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| image | string \| Buffer | | Imagen para enfocar | -| lvl | number | 1 | intensidad de la nitidez | +| Param | Type | Description | +| --- | --- | --- | +| image | string \| Buffer | Imagen para enfocar | +| lvl | number | intensidad de la nitidez | **Example** ```js @@ -322,22 +354,22 @@ Agudizar una imagen canvacard.write(sharpened, "sharpened.png"); }) .catch(console.error); ``` - + -### Canvacard.burn(image, lvl) ⇒ Promise.<Buffer> +## burn(image, lvl) ⇒ Promise.<Buffer> Aplica efecto de quemado en una imagen. -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen quemada **Throws**: - APIError Si no se proporciona la imagen o el nivel no es un número -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| image | string \| Buffer | | Fuente de imagen | -| lvl | number | 1 | intensidad | +| Param | Type | Description | +| --- | --- | --- | +| image | string \| Buffer | Fuente de imagen | +| lvl | number | intensidad | **Example** ```js @@ -347,12 +379,12 @@ Aplica efecto de quemado en una imagen. canvacard.write(burned, "burned.png"); }) .catch(console.error); ``` - + -### Canvacard.circle(image) ⇒ Promise.<Buffer> +## circle(image) ⇒ Promise.<Buffer> Crea una imagen circular -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen circular **Throws**: @@ -371,12 +403,12 @@ Crea una imagen circular canvacard.write(circled, "circled.png"); }) .catch(console.error); ``` - + -### Canvacard.fuse(image1, image2) ⇒ Promise.<Buffer> +## fuse(image1, image2) ⇒ Promise.<Buffer> Fusiona dos imágenes -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen fusionada **Throws**: @@ -396,12 +428,12 @@ Fusiona dos imágenes canvacard.write(fused, "fused.png"); }) .catch(console.error); ``` - + -### Canvacard.resize(image, width, height) ⇒ Promise.<Buffer> +## resize(image, width, height) ⇒ Promise.<Buffer> Cambiar el tamaño de una imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen redimensionada **Throws**: @@ -422,12 +454,12 @@ Cambiar el tamaño de una imagen canvacard.write(resized, "resized.png"); }) .catch(console.error); ``` - + -### Canvacard.kiss(image1, image2) ⇒ Promise.<Buffer> +## kiss(image1, image2) ⇒ Promise.<Buffer> Besarse ( ͡° ͜ʖ ͡°) -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de beso **Throws**: @@ -447,12 +479,12 @@ Besarse ( ͡° ͜ʖ ͡°) canvacard.write(kissed, "kissed.png"); }) .catch(console.error); ``` - + -### Canvacard.spank(image1, image2) ⇒ Promise.<Buffer> +## spank(image1, image2) ⇒ Promise.<Buffer> Azotar a alguien ( ͡° ͜ʖ ͡°) -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de "spank" **Throws**: @@ -472,12 +504,12 @@ Azotar a alguien ( ͡° ͜ʖ ͡°) canvacard.write(spanked, "spanked.png"); }) .catch(console.error); ``` - + -### Canvacard.slap(image1, image2) ⇒ Promise.<Buffer> +## slap(image1, image2) ⇒ Promise.<Buffer> Abofetear a alguien ( ͡° ͜ʖ ͡°) -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de "slap" **Throws**: @@ -497,12 +529,12 @@ Abofetear a alguien ( ͡° ͜ʖ ͡°) canvacard.write(slap, "slap.png"); }) .catch(console.error); ``` - + -### Canvacard.facepalm(image) ⇒ Promise.<Buffer> -facepalm +## facepalm(image) ⇒ Promise.<Buffer> +Hacer una imagen de palma en la cara -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de facepalm **Throws**: @@ -521,12 +553,12 @@ facepalm canvacard.write(facepalm, "facepalm.png"); }) .catch(console.error); ``` - + -### Canvacard.colorfy(image, color) ⇒ Promise.<Buffer> +## colorfy(image, color) ⇒ Promise.<Buffer> Actualiza el color de la imagen -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen coloreada **Throws**: @@ -546,23 +578,23 @@ Actualiza el color de la imagen canvacard.write(colorfy, "colorfy.png"); }) .catch(console.error); ``` - + -### Canvacard.distracted(image1, image2, image3) ⇒ Promise.<Buffer> -Novio distraído +## distracted(image1, image2, image3) ⇒ Promise.<Buffer> +Crear una imagen de meme de distracción -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de distracción **Throws**: - APIError Si no se proporciona la primera imagen -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| image1 | string \| Buffer | | Rostro para la niña en color rojo. | -| image2 | string \| Buffer | | Cara para el chico | -| image3 | string \| Buffer | null | Cara para la otra chica [opcional] | +| Param | Type | Description | +| --- | --- | --- | +| image1 | string \| Buffer | Rostro para la niña en color rojo. | +| image2 | string \| Buffer | Cara para el chico | +| image3 | string \| Buffer | Cara para la otra chica [opcional] | **Example** ```js @@ -572,22 +604,22 @@ Novio distraído canvacard.write(distracted, "distracted.png"); }) .catch(console.error); ``` - + -### Canvacard.jail(image, greyscale) ⇒ Promise.<Buffer> -Celda +## jail(image, greyscale) ⇒ Promise.<Buffer> +Crear una imagen de celda -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de la celda **Throws**: - APIError Si no se proporciona la imagen -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| image | string \| Buffer | | Fuente de imagen | -| greyscale | boolean | false | Si debe ser una imagen en escala de grises | +| Param | Type | Description | +| --- | --- | --- | +| image | string \| Buffer | Fuente de imagen | +| greyscale | boolean | Si debe ser una imagen en escala de grises | **Example** ```js @@ -597,12 +629,12 @@ Celda canvacard.write(jail, "jail.png"); }) .catch(console.error); ``` - + -### Canvacard.bed(image1, image2) ⇒ Promise.<Buffer> -Cama +## bed(image1, image2) ⇒ Promise.<Buffer> +Crear una imagen de cama -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de cama **Throws**: @@ -622,22 +654,22 @@ Cama canvacard.write(bed, "bed.png"); }) .catch(console.error); ``` - + -### Canvacard.delete(image, dark) ⇒ Promise.<Buffer> -Borrar +## delete(image, dark) ⇒ Promise.<Buffer> +Crear una imagen eliminada -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen eliminada **Throws**: - APIError Si no se proporciona la imagen -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| image | string \| Buffer | | Fuente de imagen | -| dark | boolean | false | Si la imagen debe estar en modo oscuro | +| Param | Type | Description | +| --- | --- | --- | +| image | string \| Buffer | Fuente de imagen | +| dark | boolean | Si la imagen debe estar en modo oscuro | **Example** ```js @@ -647,12 +679,12 @@ Borrar canvacard.write(deleted, "deleted.png"); }) .catch(console.error); ``` - + -### Canvacard.gradient(colorFrom, colorTo, width, height) ⇒ Promise.<Buffer> -Crea degradado +## gradient(colorFrom, colorTo, width, height) ⇒ Promise.<Buffer> +Crear una imagen degradada -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen degradada **Throws**: @@ -674,12 +706,12 @@ Crea degradado canvacard.write(gradient, "gradient.png"); }) .catch(console.error); ``` - + -### Canvacard.quote(options, [font]) ⇒ Promise.<Buffer> -Cita falsa +## quote(options, [font]) ⇒ Promise.<Buffer> +Crear una imagen de cita falsa -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de cita falsa | Param | Type | Default | Description | @@ -699,12 +731,12 @@ Cita falsa canvacard.write(quote, "quote.png"); }) .catch(console.error); ``` - + -### Canvacard.phub(options, [font]) ⇒ Promise.<Buffer> +## phub(options, [font]) ⇒ Promise.<Buffer> Comentario de PornHub -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de comentario de PornHub **Throws**: @@ -727,12 +759,12 @@ Comentario de PornHub canvacard.write(phub, "phub.png"); }) .catch(console.error); ``` - + -### Canvacard.wanted(image) ⇒ Promise.<Buffer> -Wanted +## wanted(image) ⇒ Promise.<Buffer> +Crear una imagen de se busca -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de "wanted" **Throws**: @@ -751,12 +783,12 @@ Wanted canvacard.write(wanted, "wanted.png"); }) .catch(console.error); ``` - + -### Canvacard.wasted(image) ⇒ Promise.<Buffer> -Wasted +## wasted(image) ⇒ Promise.<Buffer> +Crear una imagen de "wasted" -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de "wasted" **Throws**: @@ -775,12 +807,12 @@ Wasted canvacard.write(wasted, "wasted.png"); }) .catch(console.error); ``` - + -### Canvacard.youtube(ops) ⇒ Promise.<Buffer> +## youtube(ops) ⇒ Promise.<Buffer> Comentario de YouTube -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de comentario de YouTube **Throws**: @@ -803,24 +835,24 @@ Comentario de YouTube canvacard.write(youtube, "youtube.png"); }) .catch(console.error); ``` - + -### Canvacard.write(data, name) ⇒ void +## write(data, name) ⇒ void Escribe los datos como archivo -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function | Param | Type | Description | | --- | --- | --- | | data | Buffer | datos para escribir | | name | string | nombre del archivo | - + -### Canvacard.reply(options) ⇒ Promise.<Buffer> +## reply(options) ⇒ Promise.<Buffer> Clon de respuesta de discord -**Kind**: static method of [Canvacard](#Canvacard) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de respuesta de discord **Throws**: @@ -855,29 +887,3 @@ const img = "https://cdn.discordapp.com/embed/avatars/0.png"; }) .then(img => canvacard.write(img, "reply.png")); ``` - - -### Canvacard.\_\_wait(dur) ⇒ Promise.<void> -Método de Canvacard utilizado para `wait`. - -**Kind**: static method of [Canvacard](#Canvacard) - -| Param | Type | Description | -| --- | --- | --- | -| dur | number | Número de milisegundos a esperar | - - - -## ConvolutionMatrix : object -Matriz de convolución Canvacard - -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| EDGES | Array.<number> | Edges Matrix | -| BLUR | Array.<number> | Blur Matrix | -| SHARPEN | Array.<number> | Sharpen Matrix | -| BURN | Array.<number> | Burn Matrix | - diff --git a/Classes/FortniteShop.md b/Classes/FortniteShop.md index be46d5f..48c4b6e 100644 --- a/Classes/FortniteShop.md +++ b/Classes/FortniteShop.md @@ -1,21 +1,23 @@ +## Functions + +
+
setToken(value) ⇒ FortniteShop
+

Establecer el token de la API de Fortnite

+
+
setText(value) ⇒ FortniteShop
+

Establecer el texto del encabezado

+
+
build([font]) ⇒ Promise.<Buffer>
+

Construir la tarjeta de la tienda de Fortnite

+
+
+ ## FortniteShop -Creador de tiene de artículos de Fortnite - -**Kind**: global class - -* [FortniteShop](#FortniteShop) - * [new FortniteShop()](#new_FortniteShop_new) - * [.setToken(value)](#FortniteShop+setToken) ⇒ [FortniteShop](#FortniteShop) - * [.setText(value)](#FortniteShop+setText) ⇒ [FortniteShop](#FortniteShop) - * [.build([font])](#FortniteShop+build) ⇒ Promise.<Buffer> - - - -### new FortniteShop() Fortnite Shop Card Preview Para obtener un token de la API de Fortnite, visite [fortnite-api.com](https://fortnite-api.com/) +**Kind**: global class Creador de tiene de artículos de Fortnite **Example** ```js const shop = new canvacard.FortniteShop() @@ -24,36 +26,44 @@ Creador de tiene de artículos de Fortnite const FortniteShopImage = await shop.build("Luckiest Guy"); canvacard.write(FortniteShopImage, "./fortnite_shop.png"); ``` - + -### fortniteShop.setToken(value) ⇒ [FortniteShop](#FortniteShop) +## setToken(value) ⇒ [FortniteShop](#FortniteShop) Establecer el token de la API de Fortnite -**Kind**: instance method of [FortniteShop](#FortniteShop) +**Kind**: global function **Returns**: [FortniteShop](#FortniteShop) - La instancia actual de FortniteShop +**Throws**: + +- APIError Si no se proporciona un token válido + | Param | Type | Description | | --- | --- | --- | | value | string | Token de la API de Fortnite | - + -### fortniteShop.setText(value) ⇒ [FortniteShop](#FortniteShop) +## setText(value) ⇒ [FortniteShop](#FortniteShop) Establecer el texto del encabezado -**Kind**: instance method of [FortniteShop](#FortniteShop) +**Kind**: global function **Returns**: [FortniteShop](#FortniteShop) - La instancia actual de FortniteShop +**Throws**: + +- APIError Si el valor no es una cadena + | Param | Type | Description | | --- | --- | --- | | value | string | Texto del encabezado | - + -### fortniteShop.build([font]) ⇒ Promise.<Buffer> +## build([font]) ⇒ Promise.<Buffer> Construir la tarjeta de la tienda de Fortnite -**Kind**: instance method of [FortniteShop](#FortniteShop) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de la tarjeta de la tienda de Fortnite **Throws**: diff --git a/Classes/Rank.md b/Classes/Rank.md index bf52649..4b2e893 100644 --- a/Classes/Rank.md +++ b/Classes/Rank.md @@ -1,31 +1,53 @@ +## Functions + +
+
setAvatar(avatarUrl, AvatarDecorationData, squareAvatar) ⇒ Rank
+

Establece el avatar del usuario

+
+
setBanner(bannerUrl, moreBackgroundBlur, disableBackgroundBlur, backgroundBrightness) ⇒ Rank
+

Establece el banner del usuario

+
+
setBadges(flags, bot, frame, customBadges) ⇒ Rank
+

Establece las insignias del usuario

+
+
setBorder(color, allign) ⇒ Rank
+

Establece el borde de la tarjeta

+
+
setUsername(name, [discriminator], [color], customUsername, customTag) ⇒ Rank
+

Establece el nombre de usuario

+
+
setCurrentXP(data, [color]) ⇒ Rank
+

Establece el nivel de experiencia actual

+
+
setRequiredXP(data, [color]) ⇒ Rank
+

Establece la experiencia requerida

+
+
setRank(data, [text], [display]) ⇒ Rank
+

Establece el ranking del usuario

+
+
setLevel(data, [text]) ⇒ Rank
+

Establece el nivel del usuario

+
+
setProgressBar(color, [fillType], [rounded]) ⇒ Rank
+

Establece la barra de progreso

+
+
setStatus(presenceStatus) ⇒ Rank
+

Establece el estado del usuario

+
+
setCreatedTimestamp(timestamp, customDate) ⇒ Rank
+

Establece la marca de tiempo de creación

+
+
build([font]) ⇒ Promise.<Buffer>
+

Construye la tarjeta de rango

+
+
+ ## Rank -Creador tarjetas de rango - -**Kind**: global class - -* [Rank](#Rank) - * [new Rank(userId)](#new_Rank_new) - * [.setAvatar(avatarUrl, AvatarDecorationData, squareAvatar)](#Rank+setAvatar) ⇒ [Rank](#Rank) - * [.setBanner(bannerUrl, moreBackgroundBlur, disableBackgroundBlur, backgroundBrightness)](#Rank+setBanner) ⇒ [Rank](#Rank) - * [.setBadges(flags, bot, frame, customBadges)](#Rank+setBadges) ⇒ [Rank](#Rank) - * [.setBorder(color, allign)](#Rank+setBorder) ⇒ [Rank](#Rank) - * [.setUsername(name, [discriminator], [color], customUsername, customTag)](#Rank+setUsername) ⇒ [Rank](#Rank) - * [.setCurrentXP(data, [color])](#Rank+setCurrentXP) ⇒ [Rank](#Rank) - * [.setRequiredXP(data, [color])](#Rank+setRequiredXP) ⇒ [Rank](#Rank) - * [.setRank(data, [text], [display])](#Rank+setRank) ⇒ [Rank](#Rank) - * [.setLevel(data, [text])](#Rank+setLevel) ⇒ [Rank](#Rank) - * [.setProgressBar(color, [fillType], [rounded])](#Rank+setProgressBar) ⇒ [Rank](#Rank) - * [.setStatus(presenceStatus)](#Rank+setStatus) ⇒ [Rank](#Rank) - * [.setCreatedTimestamp(timestamp, customDate)](#Rank+setCreatedTimestamp) ⇒ [Rank](#Rank) - * [.build([font])](#Rank+build) ⇒ Promise.<Buffer> - - - -### new Rank(userId)
PREVIEW
Rank Card Preview 1 Rank Card Preview 2 Rank Card Preview 3
+**Kind**: global class Creador tarjetas de rango | Param | Type | Description | | --- | --- | --- | @@ -50,72 +72,72 @@ Creador tarjetas de rango const rankImage = await rank.build("Cascadia Code PL"); canvacard.write(rankImage, "./rank.png"); ``` - + -### rank.setAvatar(avatarUrl, AvatarDecorationData, squareAvatar) ⇒ [Rank](#Rank) +## setAvatar(avatarUrl, AvatarDecorationData, squareAvatar) ⇒ [Rank](#Rank) Establece el avatar del usuario -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| avatarUrl | string | | URL del avatar | -| AvatarDecorationData | string | | Asset de decoración del avatar | -| squareAvatar | boolean | false | Cambiar la forma del avatar a un cuadrado | +| Param | Type | Description | +| --- | --- | --- | +| avatarUrl | string | URL del avatar | +| AvatarDecorationData | string | Asset de decoración del avatar | +| squareAvatar | boolean | Cambiar la forma del avatar a un cuadrado | - + -### rank.setBanner(bannerUrl, moreBackgroundBlur, disableBackgroundBlur, backgroundBrightness) ⇒ [Rank](#Rank) +## setBanner(bannerUrl, moreBackgroundBlur, disableBackgroundBlur, backgroundBrightness) ⇒ [Rank](#Rank) Establece el banner del usuario -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| bannerUrl | string | | URL del banner | -| moreBackgroundBlur | boolean | false | Más desenfoque de fondo | -| disableBackgroundBlur | boolean | false | Desactivar desenfoque de fondo | -| backgroundBrightness | number | 0 | Brillo de fondo | +| Param | Type | Description | +| --- | --- | --- | +| bannerUrl | string | URL del banner | +| moreBackgroundBlur | boolean | Más desenfoque de fondo | +| disableBackgroundBlur | boolean | Desactivar desenfoque de fondo | +| backgroundBrightness | number | Brillo de fondo | - + -### rank.setBadges(flags, bot, frame, customBadges) ⇒ [Rank](#Rank) +## setBadges(flags, bot, frame, customBadges) ⇒ [Rank](#Rank) Establece las insignias del usuario -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| flags | number | | Insignias del usuario | -| bot | boolean | false | Si el usuario es un bot o no | -| frame | boolean | false | Marco de insignias | -| customBadges | Array.<string> | | Insignias personalizadas | +| Param | Type | Description | +| --- | --- | --- | +| flags | number | Insignias del usuario | +| bot | boolean | Si el usuario es un bot o no | +| frame | boolean | Marco de insignias | +| customBadges | Array.<string> | Insignias personalizadas | - + -### rank.setBorder(color, allign) ⇒ [Rank](#Rank) +## setBorder(color, allign) ⇒ [Rank](#Rank) Establece el borde de la tarjeta -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Description | @@ -123,16 +145,16 @@ Establece el borde de la tarjeta | color | string \| Array.<string> | Color HEX del borde, puede ser degradado si se usan 2 colores | | allign | string | Alineación de degradado si se usan 2 colores | - + -### rank.setUsername(name, [discriminator], [color], customUsername, customTag) ⇒ [Rank](#Rank) +## setUsername(name, [discriminator], [color], customUsername, customTag) ⇒ [Rank](#Rank) Establece el nombre de usuario -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Default | Description | @@ -143,16 +165,16 @@ Establece el nombre de usuario | customUsername | string | | Nombre de usuario personalizado | | customTag | string | | Tag personalizado | - + -### rank.setCurrentXP(data, [color]) ⇒ [Rank](#Rank) +## setCurrentXP(data, [color]) ⇒ [Rank](#Rank) Establece el nivel de experiencia actual -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Default | Description | @@ -160,16 +182,16 @@ Establece el nivel de experiencia actual | data | number | | Datos de experiencia actual | | [color] | string | "\"#FFFFFF\"" | Color del texto | - + -### rank.setRequiredXP(data, [color]) ⇒ [Rank](#Rank) +## setRequiredXP(data, [color]) ⇒ [Rank](#Rank) Establece la experiencia requerida -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Default | Description | @@ -177,16 +199,16 @@ Establece la experiencia requerida | data | number | | Datos de experiencia requerida | | [color] | string | "\"#FFFFFF\"" | Color del texto | - + -### rank.setRank(data, [text], [display]) ⇒ [Rank](#Rank) +## setRank(data, [text], [display]) ⇒ [Rank](#Rank) Establece el ranking del usuario -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Default | Description | @@ -195,16 +217,16 @@ Establece el ranking del usuario | [text] | string | "\"RANK\"" | Texto de visualización | | [display] | boolean | false | Mostrar o no el sistema de rango | - + -### rank.setLevel(data, [text]) ⇒ [Rank](#Rank) +## setLevel(data, [text]) ⇒ [Rank](#Rank) Establece el nivel del usuario -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Default | Description | @@ -212,16 +234,16 @@ Establece el nivel del usuario | data | number | | Datos de nivel | | [text] | string | "\"LEVEL\"" | Texto de visualización | - + -### rank.setProgressBar(color, [fillType], [rounded]) ⇒ [Rank](#Rank) +## setProgressBar(color, [fillType], [rounded]) ⇒ [Rank](#Rank) Establece la barra de progreso -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Default | Description | @@ -230,32 +252,32 @@ Establece la barra de progreso | [fillType] | string | "\"COLOR\"" | Tipo de relleno | | [rounded] | boolean | true | Redondear o no | - + -### rank.setStatus(presenceStatus) ⇒ [Rank](#Rank) +## setStatus(presenceStatus) ⇒ [Rank](#Rank) Establece el estado del usuario -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Description | | --- | --- | --- | | presenceStatus | string | Estado del usuario | - + -### rank.setCreatedTimestamp(timestamp, customDate) ⇒ [Rank](#Rank) +## setCreatedTimestamp(timestamp, customDate) ⇒ [Rank](#Rank) Establece la marca de tiempo de creación -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: [Rank](#Rank) - La instancia de la clase Rank **Throws**: -- Error Si el URL o el asset no son válidos +- APIError Si el URL o el asset no son válidos | Param | Type | Description | @@ -263,13 +285,17 @@ Establece la marca de tiempo de creación | timestamp | number | Marca de tiempo de creación | | customDate | string \| Date | Fecha o texto personalizado para usar en lugar de cuando el usuario se unió a Discord | - + -### rank.build([font]) ⇒ Promise.<Buffer> +## build([font]) ⇒ Promise.<Buffer> Construye la tarjeta de rango -**Kind**: instance method of [Rank](#Rank) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de la tarjeta de rango en formato de buffer +**Throws**: + +- APIError Faltan datos + | Param | Type | Default | Description | | --- | --- | --- | --- | diff --git a/Classes/Spotify.md b/Classes/Spotify.md index abd9aae..a763219 100644 --- a/Classes/Spotify.md +++ b/Classes/Spotify.md @@ -1,54 +1,41 @@ -## Classes +## Functions
-
Spotify
-

Creador de tarjetas de presencia de Spotify

+
setProgressBar(type, color) ⇒ Spotify
+

Establecer detalles de la barra de progreso

+
+
setTitle(title) ⇒ Spotify
+

Establecer título

+
+
setImage(source) ⇒ Spotify
+

Establecer imagen

+
+
setAuthor(name) ⇒ Spotify
+

Establecer nombre de artista

+
+
setAlbum(name) ⇒ Spotify
+

Establecer el nombre del álbum

+
+
setStartTimestamp(time) ⇒ Spotify
+

Establecer marca de tiempo de inicio

+
+
setEndTimestamp(time) ⇒ Spotify
+

Establecer marca de tiempo de finalización

+
+
setBackground(type, data) ⇒ Spotify
+

Establecer fondo de la tarjeta

+
+
build([font]) ⇒ Promise.<Buffer>
+

Construye la tarjeta de presencia de Spotify.

-
- -## Typedefs - -
-
SpotifyDataBG : object
-
-
SpotifyProgressBarData : object
-
## Spotify -Creador de tarjetas de presencia de Spotify - -**Kind**: global class - -* [Spotify](#Spotify) - * [new Spotify()](#new_Spotify_new) - * [.title](#Spotify+title) : string - * [.image](#Spotify+image) : string \| Buffer \| Canvas.Image - * [.artist](#Spotify+artist) : string - * [.album](#Spotify+album) : string - * [.start](#Spotify+start) : number - * [.end](#Spotify+end) : number - * [.background](#Spotify+background) : [SpotifyDataBG](#SpotifyDataBG) - * [.progressBar](#Spotify+progressBar) : [SpotifyProgressBarData](#SpotifyProgressBarData) - * [.width](#Spotify+width) : number - * [.height](#Spotify+height) : number - * [.setProgressBar(type, color)](#Spotify+setProgressBar) ⇒ [Spotify](#Spotify) - * [.setTitle(title)](#Spotify+setTitle) ⇒ [Spotify](#Spotify) - * [.setImage(source)](#Spotify+setImage) ⇒ [Spotify](#Spotify) - * [.setAuthor(name)](#Spotify+setAuthor) ⇒ [Spotify](#Spotify) - * [.setAlbum(name)](#Spotify+setAlbum) ⇒ [Spotify](#Spotify) - * [.setStartTimestamp(time)](#Spotify+setStartTimestamp) ⇒ [Spotify](#Spotify) - * [.setEndTimestamp(time)](#Spotify+setEndTimestamp) ⇒ [Spotify](#Spotify) - * [.setBackground(type, data)](#Spotify+setBackground) ⇒ [Spotify](#Spotify) - * [.build([font])](#Spotify+build) ⇒ Promise.<Buffer> - - - -### new Spotify() ![Spotify Card](https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/spotify.png) +**Kind**: global class Creador de tarjetas de presencia de Spotify **Example** ```js const card = new canvacard.Spotify() @@ -60,189 +47,149 @@ Creador de tarjetas de presencia de Spotify .setTitle("YO LO SOÑÉ"); const Image = await card.build("Cascadia Code PL"); canvacard.write(Image, "./spotify.png"); ``` - - -### spotify.title : string -Título de la canción - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.image : string \| Buffer \| Canvas.Image -Thumbnail - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.artist : string -Artista de la canción - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.album : string -Nombre del álbum de Spotify - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.start : number -Marca de tiempo de inicio de presencia de discord - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.end : number -Marca de tiempo de finalización de presencia de discord - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.background : [SpotifyDataBG](#SpotifyDataBG) -Fondo - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.progressBar : [SpotifyProgressBarData](#SpotifyProgressBarData) -Detalles de la barra de progreso - -**Kind**: instance property of [Spotify](#Spotify) - - -### spotify.width : number -Ancho de la tarjeta - -**Kind**: instance property of [Spotify](#Spotify) -**Default**: 775 - + -### spotify.height : number -Altura de la tarjeta +## setProgressBar(type, color) ⇒ [Spotify](#Spotify) +Establecer detalles de la barra de progreso -**Kind**: instance property of [Spotify](#Spotify) -**Default**: 300 - +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: -### spotify.setProgressBar(type, color) ⇒ [Spotify](#Spotify) -Establecer detalles de la barra de progreso +- APIError Tipo de barra de progreso no válido -**Kind**: instance method of [Spotify](#Spotify) | Param | Type | Description | | --- | --- | --- | | type | "TRACK" \| "BAR" | Tipo de barra de progreso | | color | string | Color para establecer | - + -### spotify.setTitle(title) ⇒ [Spotify](#Spotify) +## setTitle(title) ⇒ [Spotify](#Spotify) Establecer título -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: + +- APIError Título esperado pero no recibido + | Param | Type | Description | | --- | --- | --- | | title | string | Título para establecer | - + -### spotify.setImage(source) ⇒ [Spotify](#Spotify) +## setImage(source) ⇒ [Spotify](#Spotify) Establecer imagen -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: + +- APIError Fuente de imagen esperada pero no recibida + | Param | Type | Description | | --- | --- | --- | | source | string \| Buffer \| Canvas.Image | Fuente de imagen | - + -### spotify.setAuthor(name) ⇒ [Spotify](#Spotify) +## setAuthor(name) ⇒ [Spotify](#Spotify) Establecer nombre de artista -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: + +- APIError Nombre esperado del artista pero no recibido + | Param | Type | Description | | --- | --- | --- | | name | string | Nombre del artista | - + -### spotify.setAlbum(name) ⇒ [Spotify](#Spotify) +## setAlbum(name) ⇒ [Spotify](#Spotify) Establecer el nombre del álbum -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: + +- APIError Nombre del álbum esperado pero no recibido + | Param | Type | Description | | --- | --- | --- | | name | string | Nombre del álbum | - + -### spotify.setStartTimestamp(time) ⇒ [Spotify](#Spotify) +## setStartTimestamp(time) ⇒ [Spotify](#Spotify) Establecer marca de tiempo de inicio -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: + +- APIError Marca de tiempo esperada pero no recibida + | Param | Type | Description | | --- | --- | --- | | time | Date \| number | Marca de tiempo | - + -### spotify.setEndTimestamp(time) ⇒ [Spotify](#Spotify) +## setEndTimestamp(time) ⇒ [Spotify](#Spotify) Establecer marca de tiempo de finalización -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: + +- APIError Marca de tiempo esperada pero no recibida + | Param | Type | Description | | --- | --- | --- | | time | Date \| number | Marca de tiempo | - + -### spotify.setBackground(type, data) ⇒ [Spotify](#Spotify) -Definir fondo +## setBackground(type, data) ⇒ [Spotify](#Spotify) +Establecer fondo de la tarjeta -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function +**Returns**: [Spotify](#Spotify) - La instancia actual de Spotify +**Throws**: -| Param | Type | Default | Description | -| --- | --- | --- | --- | -| type | "COLOR" \| "IMAGE" | COLOR | Tipo de fondo | -| data | string \| Buffer \| Canvas.Image | "#2F3136" | Datos de fondo | +- APIError Tipo de fondo no válido + + +| Param | Type | Description | +| --- | --- | --- | +| type | "COLOR" \| "IMAGE" | Tipo de fondo | +| data | string \| Buffer \| Canvas.Image | Datos de fondo | - + -### spotify.build([font]) ⇒ Promise.<Buffer> +## build([font]) ⇒ Promise.<Buffer> Construye la tarjeta de presencia de Spotify. -**Kind**: instance method of [Spotify](#Spotify) +**Kind**: global function **Returns**: Promise.<Buffer> - Imagen de la tarjeta de presencia de Spotify en formato de buffer +**Throws**: + +- APIError Faltan opciones + | Param | Type | Default | Description | | --- | --- | --- | --- | | [font] | string | "\"Arial\"" | Fuente de texto para la tarjeta | - - -## SpotifyDataBG : object -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| type | number | Tipo de fondo | -| data | string \| Buffer | Datos de fondo | - - - -## SpotifyProgressBarData : object -**Kind**: global typedef -**Properties** - -| Name | Type | Description | -| --- | --- | --- | -| bgColor | string | Barra de progreso bg color | -| color | string | Barra de progreso bg color | -