feat: Testeo para la documentación.

SrGobi · Oct 22, 2024 · 85347c9 · 85347c9
1 parent 1231731
commit 85347c9
Showing 1 changed file with 174 additions and 56 deletions.
diff --git a/Classes/WelcomeLeave.md b/Classes/WelcomeLeave.md
@@ -1,11 +1,42 @@
+## Classes
+
+<dl>
+<dt><a href="#WelcomeLeave">WelcomeLeave</a></dt>
+<dd></dd>
+<dt><a href="#WelcomeLeave">WelcomeLeave</a></dt>
+<dd></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#setAvatarEstablecer el avatar de la tarjeta">setAvatarEstablecer el avatar de la tarjeta(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#setTituloEstablecer el título de la tarjeta">setTituloEstablecer el título de la tarjeta(value, color)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#setSubtituloEstablecer el subtítulo de la tarjeta">setSubtituloEstablecer el subtítulo de la tarjeta(value, color)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#setColorCircleEstablecer el color del circulo">setColorCircleEstablecer el color del circulo(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#setColorOverlayEstablecer el color del overlay">setColorOverlayEstablecer el color del overlay(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#setOpacityOverlayEstablecer la opacidad del overlay">setOpacityOverlayEstablecer la opacidad del overlay(value)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#setBackgroundEstablecer imagen / color de fondo">setBackgroundEstablecer imagen / color de fondo(type, data)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#setTypeOverlayEstablecer rectangle / rounded de overlay">setTypeOverlayEstablecer rectangle / rounded de overlay(type)</a> ⇒ <code><a href="#WelcomeLeave">WelcomeLeave</a></code></dt>
+<dd></dd>
+<dt><a href="#buildConstruye la tarjeta de bienvenida">buildConstruye la tarjeta de bienvenida([font])</a> ⇒ <code>Promise.&lt;Buffer&gt;</code></dt>
+<dd></dd>
+</dl>
+
 <a name="WelcomeLeave"></a>
 
 ## WelcomeLeave
-Creador de tarjetas de bienvenida
-
 **Kind**: global class  
 
 * [WelcomeLeave](#WelcomeLeave)
+    * [new WelcomeLeave()](#new_WelcomeLeave_new)
     * [new WelcomeLeave()](#new_WelcomeLeave_new)
     * [.backgroundGlobal](#WelcomeLeave+backgroundGlobal)
     * [.avatar](#WelcomeLeave+avatar) : <code>string</code>
@@ -17,15 +48,11 @@ Creador de tarjetas de bienvenida
     * [.colorOverlay](#WelcomeLeave+colorOverlay) : <code>number</code> \| <code>string</code>
     * [.opacityOverlay](#WelcomeLeave+opacityOverlay) : <code>string</code>
     * [.typeOverlay](#WelcomeLeave+typeOverlay) : <code>string</code>
-    * [.setAvatar(value)](#WelcomeLeave+setAvatar) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.setTitulo(value, color)](#WelcomeLeave+setTitulo) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.setSubtitulo(value, color)](#WelcomeLeave+setSubtitulo) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.setColorCircle(value)](#WelcomeLeave+setColorCircle) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.setColorOverlay(value)](#WelcomeLeave+setColorOverlay) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.setOpacityOverlay(value)](#WelcomeLeave+setOpacityOverlay) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.setBackground(type, data)](#WelcomeLeave+setBackground) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.setTypeOverlay(type)](#WelcomeLeave+setTypeOverlay) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-    * [.build([font])](#WelcomeLeave+build) ⇒ <code>Promise.&lt;Buffer&gt;</code>
+
+<a name="new_WelcomeLeave_new"></a>
+
+### new WelcomeLeave()
+Creador de tarjetas de bienvenida o despedida
 
 <a name="new_WelcomeLeave_new"></a>
 
@@ -44,7 +71,7 @@ Creador de tarjetas de bienvenida
       .setColorOverlay('#5865F2')
       .setTypeOverlay('ROUNDED');
     const welcomeImage = await welcome.build("Suravaram");
-    canvacard.write(welcomeImage, "./welcomer.png");```Constructor de la tarjeta de bienvenida
+    canvacard.write(welcomeImage, "./welcomer.png");```
 <a name="WelcomeLeave+backgroundGlobal"></a>
 
 ### welcomeLeave.backgroundGlobal
@@ -112,12 +139,119 @@ Opacidad del overlay
 Tipo de overlay
 
 **Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
-<a name="WelcomeLeave+setAvatar"></a>
+<a name="WelcomeLeave"></a>
 
-### welcomeLeave.setAvatar(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Valor del avatar
+## WelcomeLeave
+**Kind**: global class  
 
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+* [WelcomeLeave](#WelcomeLeave)
+    * [new WelcomeLeave()](#new_WelcomeLeave_new)
+    * [new WelcomeLeave()](#new_WelcomeLeave_new)
+    * [.backgroundGlobal](#WelcomeLeave+backgroundGlobal)
+    * [.avatar](#WelcomeLeave+avatar) : <code>string</code>
+    * [.titulo](#WelcomeLeave+titulo) : <code>string</code>
+    * [.subtitulo](#WelcomeLeave+subtitulo) : <code>string</code>
+    * [.colorTitulo](#WelcomeLeave+colorTitulo) : <code>string</code>
+    * [.colorSubtitulo](#WelcomeLeave+colorSubtitulo) : <code>string</code>
+    * [.colorCircle](#WelcomeLeave+colorCircle) : <code>string</code>
+    * [.colorOverlay](#WelcomeLeave+colorOverlay) : <code>number</code> \| <code>string</code>
+    * [.opacityOverlay](#WelcomeLeave+opacityOverlay) : <code>string</code>
+    * [.typeOverlay](#WelcomeLeave+typeOverlay) : <code>string</code>
+
+<a name="new_WelcomeLeave_new"></a>
+
+### new WelcomeLeave()
+Creador de tarjetas de bienvenida o despedida
+
+<a name="new_WelcomeLeave_new"></a>
+
+### new WelcomeLeave()
+<details open> <summary>PREVIEW</summary><br>  <a>    <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_1.png" alt="Welcome Card Preview 1">  </a>  <a>    <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_2.png" alt="Welcome Card Preview 2">  </a>  <a>    <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_3.png" alt="Welcome Card Preview 3">  </a>  <a>    <img src="https://raw.githubusercontent.com/SrGobi/canvacard/refs/heads/test/welcome_4.png" alt="Welcome Card Preview 4">  </a></details>
+
+**Example**  
+```js
+    const welcome = new canvacard.Welcomer()
+      .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");```
+<a name="WelcomeLeave+backgroundGlobal"></a>
+
+### welcomeLeave.backgroundGlobal
+Fondo de la tarjeta
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| backgroundGlobal | <code>object</code> |  | Fondo de la tarjeta |
+| [backgroundGlobal.type] | <code>&quot;IMAGE&quot;</code> \| <code>&quot;COLOR&quot;</code> | <code>&quot;color&quot;</code> | Tipo de fondo |
+
+<a name="WelcomeLeave+avatar"></a>
+
+### welcomeLeave.avatar : <code>string</code>
+Avatar de la tarjeta
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+titulo"></a>
+
+### welcomeLeave.titulo : <code>string</code>
+Título creado con Canvacard
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+subtitulo"></a>
+
+### welcomeLeave.subtitulo : <code>string</code>
+Subtítulo creado con Canvacard
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+colorTitulo"></a>
+
+### welcomeLeave.colorTitulo : <code>string</code>
+Color del título creado con Canvacard
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+colorSubtitulo"></a>
+
+### welcomeLeave.colorSubtitulo : <code>string</code>
+Color del Subtítulo creado con Canvacard
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+colorCircle"></a>
+
+### welcomeLeave.colorCircle : <code>string</code>
+Color del circulo
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+colorOverlay"></a>
+
+### welcomeLeave.colorOverlay : <code>number</code> \| <code>string</code>
+Color del overlay
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+opacityOverlay"></a>
+
+### welcomeLeave.opacityOverlay : <code>string</code>
+Opacidad del overlay
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="WelcomeLeave+typeOverlay"></a>
+
+### welcomeLeave.typeOverlay : <code>string</code>
+Tipo de overlay
+
+**Kind**: instance property of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+<a name="setAvatarEstablecer el avatar de la tarjeta"></a>
+
+## setAvatarEstablecer el avatar de la tarjeta(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -128,12 +262,10 @@ Valor del avatar
 | --- | --- | --- |
 | value | <code>string</code> \| <code>Buffer</code> | URL de la imagen o Buffer de la imagen |
 
-<a name="WelcomeLeave+setTitulo"></a>
-
-### welcomeLeave.setTitulo(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Valor del título
+<a name="setTituloEstablecer el título de la tarjeta"></a>
 
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## setTituloEstablecer el título de la tarjeta(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -145,12 +277,10 @@ Valor del título
 | value | <code>string</code> | Valor del título |
 | color | <code>string</code> | Código de color HTML5 "#000000" |
 
-<a name="WelcomeLeave+setSubtitulo"></a>
+<a name="setSubtituloEstablecer el subtítulo de la tarjeta"></a>
 
-### welcomeLeave.setSubtitulo(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Valor del subtítulo
-
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## setSubtituloEstablecer el subtítulo de la tarjeta(value, color) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -162,12 +292,10 @@ Valor del subtítulo
 | value | <code>string</code> | Valor del subtítulo |
 | color | <code>string</code> | Código de color HTML5 "#000000" |
 
-<a name="WelcomeLeave+setColorCircle"></a>
-
-### welcomeLeave.setColorCircle(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Valor del color del círculo
+<a name="setColorCircleEstablecer el color del circulo"></a>
 
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## setColorCircleEstablecer el color del circulo(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -178,12 +306,10 @@ Valor del color del círculo
 | --- | --- | --- |
 | value | <code>string</code> | Código de color HTML5 "#000000" |
 
-<a name="WelcomeLeave+setColorOverlay"></a>
+<a name="setColorOverlayEstablecer el color del overlay"></a>
 
-### welcomeLeave.setColorOverlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Valor del color del overlay
-
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## setColorOverlayEstablecer el color del overlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -194,12 +320,10 @@ Valor del color del overlay
 | --- | --- | --- |
 | value | <code>string</code> | Código de color HTML5 "#000000" |
 
-<a name="WelcomeLeave+setOpacityOverlay"></a>
-
-### welcomeLeave.setOpacityOverlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Valor del color del overlay
+<a name="setOpacityOverlayEstablecer la opacidad del overlay"></a>
 
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## setOpacityOverlayEstablecer la opacidad del overlay(value) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -210,12 +334,10 @@ Valor del color del overlay
 | --- | --- | --- |
 | value | <code>number</code> | Valor de 0 a 1 para la opacidad |
 
-<a name="WelcomeLeave+setBackground"></a>
+<a name="setBackgroundEstablecer imagen / color de fondo"></a>
 
-### welcomeLeave.setBackground(type, data) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Establecer imagen / color de fondo
-
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## setBackgroundEstablecer imagen / color de fondo(type, data) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -227,12 +349,10 @@ Establecer imagen / color de fondo
 | type | <code>&quot;COLOR&quot;</code> \| <code>&quot;IMAGE&quot;</code> | Tipo de fondo |
 | data | <code>string</code> | URL de la imagen o código de color HTML |
 
-<a name="WelcomeLeave+setTypeOverlay"></a>
-
-### welcomeLeave.setTypeOverlay(type) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
-Establecer rectangle / rounded de overlay
+<a name="setTypeOverlayEstablecer rectangle / rounded de overlay"></a>
 
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## setTypeOverlayEstablecer rectangle / rounded de overlay(type) ⇒ [<code>WelcomeLeave</code>](#WelcomeLeave)
+**Kind**: global function  
 **Returns**: [<code>WelcomeLeave</code>](#WelcomeLeave) - La instancia actual de WelcomeLeave  
 **Throws**:
 
@@ -243,12 +363,10 @@ Establecer rectangle / rounded de overlay
 | --- | --- | --- |
 | type | <code>&quot;RECTANGLE&quot;</code> \| <code>&quot;ROUNDED&quot;</code> | Tipo de fondo |
 
-<a name="WelcomeLeave+build"></a>
-
-### welcomeLeave.build([font]) ⇒ <code>Promise.&lt;Buffer&gt;</code>
-Construye la tarjeta de bienvenida
+<a name="buildConstruye la tarjeta de bienvenida"></a>
 
-**Kind**: instance method of [<code>WelcomeLeave</code>](#WelcomeLeave)  
+## buildConstruye la tarjeta de bienvenida([font]) ⇒ <code>Promise.&lt;Buffer&gt;</code>
+**Kind**: global function  
 **Returns**: <code>Promise.&lt;Buffer&gt;</code> - Imagen de la tarjeta de bienvenida en formato de buffer  
 **Throws**: