Skip to content

Commit

Permalink
👷🏽Test documents build
Browse files Browse the repository at this point in the history
  • Loading branch information
SrGobi committed Feb 22, 2024
1 parent e6a49cc commit e9db472
Show file tree
Hide file tree
Showing 17 changed files with 2,570 additions and 412 deletions.
Empty file added docs/class/Assets.md
Empty file.
759 changes: 759 additions & 0 deletions docs/class/Canvacard.md

Large diffs are not rendered by default.

Empty file added docs/class/FortniteShop.js.md
Empty file.
180 changes: 180 additions & 0 deletions docs/class/FortniteShop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
## Classes

<dl>
<dt><a href="#FortniteShop">FortniteShop</a></dt>
<dd><p>Creador de imagen de la tienda de fortnite</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#formatVariable">formatVariable(prefix, variable)</a> ⇒</dt>
<dd><p>Obtiene variables y tipos</p>
</dd>
<dt><a href="#applyText">applyText(canvas, text, defaultFontSize, width, font)</a> ⇒</dt>
<dd><p>Obtiene variables y tipos</p>
</dd>
</dl>

<a name="FortniteShop"></a>

## FortniteShop
Creador de imagen de la tienda de fortnite

**Kind**: global class

* [FortniteShop](#FortniteShop)
* [new FortniteShop()](#new_FortniteShop_new)
* [.token](#FortniteShop+token) : <code>string</code>
* [.textHeader](#FortniteShop+textHeader) : <code>string</code>
* [.textDaily](#FortniteShop+textDaily) : <code>string</code>
* [.textFeatured](#FortniteShop+textFeatured) : <code>string</code>
* [.textDate](#FortniteShop+textDate) : <code>string</code>
* [.textFooter](#FortniteShop+textFooter) : <code>string</code>
* [.background](#FortniteShop+background) : <code>string</code>
* [.setToken(value)](#FortniteShop+setToken)[<code>FortniteShop</code>](#FortniteShop)
* [.setBackground(value)](#FortniteShop+setBackground)[<code>FortniteShop</code>](#FortniteShop)
* [.setText(value)](#FortniteShop+setText)[<code>FortniteShop</code>](#FortniteShop)
* [.lang(value)](#FortniteShop+lang)[<code>FortniteShop</code>](#FortniteShop)
* [.dateFormat(value)](#FortniteShop+dateFormat)[<code>FortniteShop</code>](#FortniteShop)

<a name="new_FortniteShop_new"></a>

### new FortniteShop()
FortniteShop image builder

**Example**
```js
const FortniteShopCardURL = await new FortniteShop()
.setToken("3533192f-66bc-48b2-8df9-c03bfeb75957")
.setText("footer", "ESP CUSTOMS X FORTNITE")
.toAttachment();
await channel.send({ files: [{ attachment: FortniteShopCardURL, name: 'FortniteShop.png' }] })
```
<a name="FortniteShop+token"></a>

### fortniteShop.token : <code>string</code>
Token

**Kind**: instance property of [<code>FortniteShop</code>](#FortniteShop)
<a name="FortniteShop+textHeader"></a>

### fortniteShop.textHeader : <code>string</code>
Texto del encabezado

**Kind**: instance property of [<code>FortniteShop</code>](#FortniteShop)
<a name="FortniteShop+textDaily"></a>

### fortniteShop.textDaily : <code>string</code>
Texto del dia

**Kind**: instance property of [<code>FortniteShop</code>](#FortniteShop)
<a name="FortniteShop+textFeatured"></a>

### fortniteShop.textFeatured : <code>string</code>
Texto de destacados

**Kind**: instance property of [<code>FortniteShop</code>](#FortniteShop)
<a name="FortniteShop+textDate"></a>

### fortniteShop.textDate : <code>string</code>
Textos de datos

**Kind**: instance property of [<code>FortniteShop</code>](#FortniteShop)
<a name="FortniteShop+textFooter"></a>

### fortniteShop.textFooter : <code>string</code>
Texto del footer

**Kind**: instance property of [<code>FortniteShop</code>](#FortniteShop)
<a name="FortniteShop+background"></a>

### fortniteShop.background : <code>string</code>
imagen de fondo

**Kind**: instance property of [<code>FortniteShop</code>](#FortniteShop)
<a name="FortniteShop+setToken"></a>

### fortniteShop.setToken(value) ⇒ [<code>FortniteShop</code>](#FortniteShop)
Valor del Token

**Kind**: instance method of [<code>FortniteShop</code>](#FortniteShop)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="FortniteShop+setBackground"></a>

### fortniteShop.setBackground(value) ⇒ [<code>FortniteShop</code>](#FortniteShop)
Valor del background

**Kind**: instance method of [<code>FortniteShop</code>](#FortniteShop)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="FortniteShop+setText"></a>

### fortniteShop.setText(value) ⇒ [<code>FortniteShop</code>](#FortniteShop)
Valor del texto

**Kind**: instance method of [<code>FortniteShop</code>](#FortniteShop)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="FortniteShop+lang"></a>

### fortniteShop.lang(value) ⇒ [<code>FortniteShop</code>](#FortniteShop)
Valor del idioma

**Kind**: instance method of [<code>FortniteShop</code>](#FortniteShop)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="FortniteShop+dateFormat"></a>

### fortniteShop.dateFormat(value) ⇒ [<code>FortniteShop</code>](#FortniteShop)
Valor del formato de fecha

**Kind**: instance method of [<code>FortniteShop</code>](#FortniteShop)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="formatVariable"></a>

## formatVariable(prefix, variable) ⇒
Obtiene variables y tipos

**Kind**: global function
**Returns**: La variable formateada

| Param | Type | Description |
| --- | --- | --- |
| prefix | <code>object</code> | El tipo de variable |
| variable | <code>object</code> | La variable a cambiar |

<a name="applyText"></a>

## applyText(canvas, text, defaultFontSize, width, font) ⇒
Obtiene variables y tipos

**Kind**: global function
**Returns**: La variable formateada

| Param | Type | Description |
| --- | --- | --- |
| canvas | <code>object</code> | El lienzo |
| text | <code>object</code> | El texto |
| defaultFontSize | <code>object</code> | El tamaño de píxel de fuente predeterminado |
| width | <code>object</code> | El ancho máximo del texto |
| font | <code>object</code> | La fuente del texto |

207 changes: 207 additions & 0 deletions docs/class/FortniteStats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
## Classes

<dl>
<dt><a href="#FortniteStats">FortniteStats</a></dt>
<dd><p>Creador de imagen de estadisticas de fortnite</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#formatVariable">formatVariable(prefix, variable)</a> ⇒</dt>
<dd><p>Obtiene variables y tipos</p>
</dd>
</dl>

<a name="FortniteStats"></a>

## FortniteStats
Creador de imagen de estadisticas de fortnite

**Kind**: global class

* [FortniteStats](#FortniteStats)
* [new FortniteStats()](#new_FortniteStats_new)
* [.token](#FortniteStats+token) : <code>string</code>
* [.platform](#FortniteStats+platform) : <code>string</code>
* [.user](#FortniteStats+user) : <code>string</code>
* [.textFooter](#FortniteStats+textFooter) : <code>string</code>
* [.textAverageKills](#FortniteStats+textAverageKills) : <code>string</code>
* [.textAverageKill](#FortniteStats+textAverageKill) : <code>string</code>
* [.textWPercent](#FortniteStats+textWPercent) : <code>string</code>
* [.textWinPercent](#FortniteStats+textWinPercent) : <code>string</code>
* [.textKD](#FortniteStats+textKD) : <code>string</code>
* [.textWins](#FortniteStats+textWins) : <code>string</code>
* [.textWin](#FortniteStats+textWin) : <code>string</code>
* [.textKills](#FortniteStats+textKills) : <code>string</code>
* [.textKill](#FortniteStats+textKill) : <code>string</code>
* [.textMatches](#FortniteStats+textMatches) : <code>string</code>
* [.textMatch](#FortniteStats+textMatch) : <code>string</code>
* [.setToken(value)](#FortniteStats+setToken)[<code>FortniteStats</code>](#FortniteStats)
* [.setPlatform(value)](#FortniteStats+setPlatform)[<code>FortniteStats</code>](#FortniteStats)
* [.setUser(value)](#FortniteStats+setUser)[<code>FortniteStats</code>](#FortniteStats)
* [.setText(value)](#FortniteStats+setText)[<code>FortniteStats</code>](#FortniteStats)

<a name="new_FortniteStats_new"></a>

### new FortniteStats()
FortniteStats image builder

**Example**
```js
const FortniteStatsCardURL = await new FortniteStats()
.setToken("3533192f-66bc-48b2-8df9-c03bfeb75957")
.setUser("BLD SRGOBI")
.setPlatform("pc")
.setText("footer", "ESP CUSTOMS X FORTNITE")
.toAttachment();
await channel.send({ files: [{ attachment: FortniteStatsCardURL, name: 'FortniteStats.png' }] })
```
<a name="FortniteStats+token"></a>

### fortniteStats.token : <code>string</code>
Token

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+platform"></a>

### fortniteStats.platform : <code>string</code>
Plaraforma

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+user"></a>

### fortniteStats.user : <code>string</code>
Nombre de usuario

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textFooter"></a>

### fortniteStats.textFooter : <code>string</code>
Texto del footer

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textAverageKills"></a>

### fortniteStats.textAverageKills : <code>string</code>
Texto AvengersKills

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textAverageKill"></a>

### fortniteStats.textAverageKill : <code>string</code>
Texto AverageKill

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textWPercent"></a>

### fortniteStats.textWPercent : <code>string</code>
Texto Porcejtage victoria

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textWinPercent"></a>

### fortniteStats.textWinPercent : <code>string</code>
Texto Porcejtage victorias

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textKD"></a>

### fortniteStats.textKD : <code>string</code>
Texto KD

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textWins"></a>

### fortniteStats.textWins : <code>string</code>
Texto Victorias

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textWin"></a>

### fortniteStats.textWin : <code>string</code>
Texto Victoria

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textKills"></a>

### fortniteStats.textKills : <code>string</code>
Texto Kills

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textKill"></a>

### fortniteStats.textKill : <code>string</code>
Texto Kill

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textMatches"></a>

### fortniteStats.textMatches : <code>string</code>
Texto Partidas jugadas

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+textMatch"></a>

### fortniteStats.textMatch : <code>string</code>
Texto Partida jugada

**Kind**: instance property of [<code>FortniteStats</code>](#FortniteStats)
<a name="FortniteStats+setToken"></a>

### fortniteStats.setToken(value) ⇒ [<code>FortniteStats</code>](#FortniteStats)
Valor del Token

**Kind**: instance method of [<code>FortniteStats</code>](#FortniteStats)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="FortniteStats+setPlatform"></a>

### fortniteStats.setPlatform(value) ⇒ [<code>FortniteStats</code>](#FortniteStats)
Valor de la plataforma

**Kind**: instance method of [<code>FortniteStats</code>](#FortniteStats)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="FortniteStats+setUser"></a>

### fortniteStats.setUser(value) ⇒ [<code>FortniteStats</code>](#FortniteStats)
Valor del usuario

**Kind**: instance method of [<code>FortniteStats</code>](#FortniteStats)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="FortniteStats+setText"></a>

### fortniteStats.setText(value) ⇒ [<code>FortniteStats</code>](#FortniteStats)
Valor del texto

**Kind**: instance method of [<code>FortniteStats</code>](#FortniteStats)

| Param | Type |
| --- | --- |
| value | <code>string</code> |

<a name="formatVariable"></a>

## formatVariable(prefix, variable) ⇒
Obtiene variables y tipos

**Kind**: global function
**Returns**: La variable formateada

| Param | Type | Description |
| --- | --- | --- |
| prefix | <code>object</code> | El tipo de variable |
| variable | <code>object</code> | La variable a cambiar |

Loading

0 comments on commit e9db472

Please sign in to comment.