theoludwig/FunctionProject
theoludwig/FunctionProject
Archived
1
1
Fork 0
Code Pull Requests Actions Releases Activity
This repository has been archived on 2024-10-29. You can view files and clone it, but cannot push or open issues or pull requests.
4056781fac
FunctionProject/__documentation/global.html

5607 lines
62 KiB
HTML
Raw Normal View History

Code Documentation
2019-11-11 17:55:52 +01:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Functions</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h4 class="name" id="armstrongNumber"><span class="type-signature"></span>armstrongNumber<span class="signature">(number)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Vérifie si un nombre fait partie des nombres d'Armstrong.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>number</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Le nombre à tester</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line535">line 535</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>armstrongNumber(153) → 153 est un nombre d'Armstrong, car 1&lt;sup>3&lt;/sup> + 5&lt;sup>3&lt;/sup> + 3&lt;sup>3&lt;/sup> = 153.</code></pre>
<h4 class="name" id="binaryToDecimal"><span class="type-signature"></span>binaryToDecimal<span class="signature">(value)</span><span class="type-signature"> &rarr; {number|string}</span></h4>
<div class="description">
Convertis un nombre binaire en décimal.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Le nombre à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line258">line 258</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>formatNumberResult</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
- Le nombre en décimal soit en nombre ou soit en string si supérieur à 1000 car pour 1000 par exemple formatNumberResult renvoie '1 000'
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>binaryToDecimal('10') → 2</code></pre>
<h4 class="name" id="binaryToHexadecimal"><span class="type-signature"></span>binaryToHexadecimal<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis un nombre binaire en hexadécimal.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Le nombre à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line309">line 309</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Le nombre en hexadécimal
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>binaryToHexadecimal('1111') → 'F'</code></pre>
<h4 class="name" id="binaryToText"><span class="type-signature"></span>binaryToText<span class="signature">(s)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis du Binaire (UTF-8) en Texte.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>s</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">La chaîne de caractère contenant tous les octets à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line405">line 405</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>binaryToText('01100001 01100010 01100011') → 'abc'</code></pre>
<h4 class="name" id="calculateAge"><span class="type-signature"></span>calculateAge<span class="signature">(birthDateEntered)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Calcule l'âge de quelqu'un selon ça date de naissance.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>birthDateEntered</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Date de naissance (dd/mm/yyyy)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line53">line 53</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://momentjs.com/">https://momentjs.com/</a></li>
</ul>
</dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>formatNumberResult, isValidDate</li>
<li>"external:moment.js"</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
- L'âge en jours, mois et années
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>calculateAge('31/03/2003')</code></pre>
<h4 class="name" id="capitalize"><span class="type-signature"></span>capitalize<span class="signature">(s)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Majuscule à la 1ère lettre d'une string.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>s</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line41">line 41</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>capitalize('hello world!') → 'Hello world!'</code></pre>
<h4 class="name" id="convertArabicToRoman"><span class="type-signature"></span>convertArabicToRoman<span class="signature">(nombre)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis un nombre arabe en nombre romain.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>nombre</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Le nombre arabe à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line467">line 467</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>correspondancesRomainArabe</li>
</ul>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>convertArabicToRoman(24) → 'XXIV'</code></pre>
<h4 class="name" id="convertCurrency"><span class="type-signature"></span>convertCurrency<span class="signature">(value, currency, url)</span><span class="type-signature"></span></h4>
<div class="description">
Convertis une valeur dans une devise dans une autre devise grâce à l'API exchangeratesapi.io.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">la valeur à convertir</td>
</tr>
<tr>
<td class="name"><code>currency</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">la devise à avoir après conversion</td>
</tr>
<tr>
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">l'url de la requête à l'API en fonction du paramètre dans l'url '?base='</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line197">line 197</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://jquery.com/">https://jquery.com/</a> Requête en AJAX avec jQuery</li>
<li><a href="https://api.exchangeratesapi.io/">https://api.exchangeratesapi.io/</a> API de taux de change</li>
</ul>
</dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>formatNumberResult</li>
<li>correspondancesMonnaie</li>
</ul>
<h5>Example</h5>
<pre class="prettyprint"><code>convertCurrency(50, "$ Américain", "https://api.exchangeratesapi.io/latest?base=EUR")
Ajoute au DOM de la page dans la div .results et .rateDate :
50 EUR = 55.17 $ Américain
Dernier rafraîchissement du taux d'échange : 08/11/2019</code></pre>
<h4 class="name" id="convertDistance"><span class="type-signature"></span>convertDistance<span class="signature">(firstValue, unitFirstValue, unitFinalValue)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis la longueur (distance) avec les unités allant de picomètre au Téramètre.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>firstValue</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Le nombre que vous voulez convertir</td>
</tr>
<tr>
<td class="name"><code>unitFirstValue</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">L'unité du nombre que vous voulez convertir</td>
</tr>
<tr>
<td class="name"><code>unitFinalValue</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">L'unité de votre nombre après la conversion</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line123">line 123</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Conversion de longueur : firstValue unitFirstValue = result
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>convertDistance(500, 'cm', 'm') → Conversion de longueur : 500 cm = 5 m</code></pre>
<h4 class="name" id="convertRomanToArabic"><span class="type-signature"></span>convertRomanToArabic<span class="signature">(str)</span><span class="type-signature"> &rarr; {number}</span></h4>
<div class="description">
Convertis un nombre romain en nombre arabe.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>str</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Le nombre romain à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line511">line 511</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>correspondancesRomainArabe</li>
</ul>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>convertRomanToArabic('XXIV') → 24</code></pre>
<h4 class="name" id="convertTemperature"><span class="type-signature"></span>convertTemperature<span class="signature">(degree, unit)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis des °C en °F et l'inverse aussi.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>degree</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Nombre de degrès</td>
</tr>
<tr>
<td class="name"><code>unit</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Unité du nombre (°C ou °F)</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- degree unit = temperatureValue
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>convertTemperature(23, '°C') → 23 °C = 73.4 °F</code></pre>
<h4 class="name" id="createSessionCookie"><span class="type-signature"></span>createSessionCookie<span class="signature">(name, value)</span><span class="type-signature"></span></h4>
<div class="description">
Créer un cookie de session.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Nom du cookie</td>
</tr>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Valeur du cookie</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line153">line 153</a>
</li></ul></dd>
</dl>
<h4 class="name" id="dateTimeUTC"><span class="type-signature"></span>dateTimeUTC<span class="signature">(utc)</span><span class="type-signature"> &rarr; {function}</span></h4>
<div class="description">
Donne la date et l'heure selon l'UTC (Universal Time Coordinated).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>utc</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Heure de décalage par rapport à l'UTC</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>showDateTime</li>
<li>timeNow, utcOffset, timeNow.setMinutes(timeNow.getMinutes() + utcOffset)</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
→ showDateTime(enteredOffset) → Retourne l'exécution de la fonction showDateTime
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">function</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>dateTimeUTC('0') </code></pre>
<h4 class="name" id="decimalToBinary"><span class="type-signature"></span>decimalToBinary<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis un nombre décimal en binaire.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Le nombre à convertir en string</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line241">line 241</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Le nombre en binaire
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>decimalToBinary('2') → '10'</code></pre>
<h4 class="name" id="decimalToHexadecimal"><span class="type-signature"></span>decimalToHexadecimal<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis un nombre décimal en hexadécimal.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Le nombre à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line275">line 275</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Le nombre en hexadécimal
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>decimalToHexadecimal('15') → 'F'</code></pre>
<h4 class="name" id="filterStudents"><span class="type-signature"></span>filterStudents<span class="signature">(filteredLetter, students)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Affiche uniquement les prénoms (qui sont dans la liste) qui commencent par la lettre souhaitée.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>filteredLetter</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">La lettre à filtré</td>
</tr>
<tr>
<td class="name"><code>students</code></td>
<td class="type">
<span class="param-type">array</span>
</td>
<td class="description last">La liste des prénoms</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line150">line 150</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Prénoms qui commence par filteredLetter (totalfilteredLetterStudents) : filteredStudents
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>filterStudents('P', ['Prénom1', 'Prénom2', 'Divlo']) → Prénoms qui commence par P (2) : Prénom1 et Prénom2.</code></pre>
<h4 class="name" id="formatNumberResult"><span class="type-signature"></span>formatNumberResult<span class="signature">(num)</span><span class="type-signature"> &rarr; {number|string}</span></h4>
<div class="description">
Formate un nombre avec des espaces.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>num</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Le nombre formaté soit en nombre ou soit en string si supérieur à 1000 car pour 1000 par exemple formatNumberResult renvoie '1 000'
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>formatNumberResult(76120) → '76 120'</code></pre>
<h4 class="name" id="getRandomQuote"><span class="type-signature"></span>getRandomQuote<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Génère aléatoirement une citation ou un proverbe.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line183">line 183</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>quotes</li>
<li>randomNumber</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
- une citation au hasard à partir de la constante 'quotes' dans variables.js
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>getRandomQuote() → " Ne fais jamais rien contre ta conscience, même si l'Etat te le demande. " &lt;br> &lt;br> - Albert Einstein</code></pre>
<h4 class="name" id="hexadecimalToBinary"><span class="type-signature"></span>hexadecimalToBinary<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis un nombre hexadécimal en binaire.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Le nombre à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line326">line 326</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- Le nombre en binaire
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>hexadecimalToBinary('F') → '1111'</code></pre>
<h4 class="name" id="hexadecimalToDecimal"><span class="type-signature"></span>hexadecimalToDecimal<span class="signature">(value)</span><span class="type-signature"> &rarr; {number|string}</span></h4>
<div class="description">
Convertis un nombre hexadécimal en décimal.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Le nombre à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line292">line 292</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>formatNumberResult</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
- Le nombre en décimal soit en nombre ou soit en string si supérieur à 1000 car pour 1000 par exemple formatNumberResult renvoie '1 000'
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
|
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>hexadecimalToDecimal('F') → 15</code></pre>
<h4 class="name" id="hexadecimalToText"><span class="type-signature"></span>hexadecimalToText<span class="signature">(s)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis de l'Hexadécimal (UTF-8) en Texte.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>s</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">La chaîne de caractère contenant tous les nombres Hexadécimal à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line450">line 450</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>hexadecimalToText('61 62 63') → 'abc'</code></pre>
<h4 class="name" id="isEmptyValue"><span class="type-signature"></span>isEmptyValue<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Vérifie si une valeur est vide.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line3">line 3</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>isEmptyValue(null) → true</code></pre>
<h4 class="name" id="isFloat"><span class="type-signature"></span>isFloat<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Vérifie si une string est un float (integer exclu).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>isFloat(76120.474) → true</code></pre>
<h4 class="name" id="isValidDate"><span class="type-signature"></span>isValidDate<span class="signature">(verifyDate, currentDate)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Vérifie si une date est valide (si la variable verifyDate a déjà exister avant la variable currentDate).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>verifyDate</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">(format : dd/mm/yyyy) sachant qu'il faut faire -1 au mois car de 0 à 11 donc par exemple 14/12/2019 sera le 14 novembre 2019</td>
</tr>
<tr>
<td class="name"><code>currentDate</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">(format : dd/mm/yyyy) pas besoin de faire -1 au mois donc par exemple 14/12/2019 sera le 14 décembre 2019</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line122">line 122</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>isValidDate('10/11/2019', '11/11/2019') → false → Comparaison entre le 10 décembre 2019 et le 11 novembre 2019
isValidDate('10/10/2019', '11/11/2019') → true → Comparison entre le 10 novembre 2019 et le 11 novembre 2019</code></pre>
<h4 class="name" id="numberUnicodeToText"><span class="type-signature"></span>numberUnicodeToText<span class="signature">(string)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis chaque codePoint Unicode en caractère.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>string</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Nombre Unicode à convertir espacé par un espace à chaque fois</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line362">line 362</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>numberUnicodeToText('97 98 99') → 'abc'</code></pre>
<h4 class="name" id="randomNumber"><span class="type-signature"></span>randomNumber<span class="signature">(min, max)</span><span class="type-signature"> &rarr; {number}</span></h4>
<div class="description">
Génère un nombre aléatoire entre un minimum inclus et un maximum inclus.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>min</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Nombre Minimum</td>
</tr>
<tr>
<td class="name"><code>max</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last">Nombre Maximum</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Nombre aléatoire
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>randomNumber(1, 2) → retourne soit 1 ou 2</code></pre>
<h4 class="name" id="realDateTime"><span class="type-signature"></span>realDateTime<span class="signature">(id)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<div class="description">
Affiche l'heure en temps réel.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>id</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line99">line 99</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
true → Toujours true
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>window.onload = realDateTime('realDateTime') → va afficher l'heure en temps réel au chargement de la page dans la balise avec l'id realDateTime</code></pre>
<h4 class="name" id="showDateTime"><span class="type-signature"></span>showDateTime<span class="signature">(utc)</span><span class="type-signature"> &rarr; {object}</span></h4>
<div class="description">
Affiche la date et l'heure (format : dd/mm/yyyy - 00:00:00).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>utc</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Heure de décalage par rapport à l'UTC</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_annexes.js.html">fonctions_annexes.js</a>, <a href="fonctions_annexes.js.html#line68">line 68</a>
</li></ul></dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>showDateTime</li>
</ul>
<h5>Returns:</h5>
<div class="param-desc">
Retourne un objet contenant l'année, le mois, le jour, l'heure, les minutes, les secondes et la date formaté
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">object</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>dateTimeUTC('0') → dateTimeUTC vous renvoie l'exécution de showDateTime</code></pre>
<h4 class="name" id="stringPermutations"><span class="type-signature"></span>stringPermutations<span class="signature">(string)</span><span class="type-signature"> &rarr; {array}</span></h4>
<div class="description">
Retourne un tableau contenant toutes les possibilités d'anagramme d'un mot.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>string</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">La chaîne de caractère à permuter</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line561">line 561</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">array</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>stringPermutations('abc') → ["abc", "acb", "bac", "bca", "cab", "cba"]</code></pre>
<h4 class="name" id="textToBinary"><span class="type-signature"></span>textToBinary<span class="signature">(s)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis un Texte en Binaire (UTF-8).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>s</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">La chaîne de caractère à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line383">line 383</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>textToBinary('abc') → '01100001 01100010 01100011'</code></pre>
<h4 class="name" id="textToHexadecimal"><span class="type-signature"></span>textToHexadecimal<span class="signature">(s)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis un Texte en Hexadécimal (UTF-8).
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>s</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">La chaîne de caractère à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line427">line 427</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>textToHexadecimal('abc') → '61 62 63'</code></pre>
<h4 class="name" id="textToNumberUnicode"><span class="type-signature"></span>textToNumberUnicode<span class="signature">(value)</span><span class="type-signature"> &rarr; {string}</span></h4>
<div class="description">
Convertis chaque caractère d'une string en codePoint Unicode.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">La chaîne de caractère à convertir</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line342">line 342</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>textToNumberUnicode('abc') → '97 98 99'</code></pre>
<h4 class="name" id="weatherRequest"><span class="type-signature"></span>weatherRequest<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Affiche la météo et l'heure locale grâce à l'API : openweathermap.org.
Le nom de la ville se récupère en Javascript qui créé un cookie pour récupérer cette variable en php.
Ainsi PHP va récupérer le JSON de l'api openweathermap.org puis ajax va se charger d'afficher le résultat.
Plus d'informations : /scripts/main.js et /php/getWeatherJson.php
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="fonctions_principales.js.html">fonctions_principales.js</a>, <a href="fonctions_principales.js.html#line3">line 3</a>
</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="https://jquery.com/">https://jquery.com/</a> Requête en AJAX avec jQuery</li>
<li><a href="https://openweathermap.org/">https://openweathermap.org/</a> API de météo</li>
</ul>
</dd>
</dl>
<h5>Requires:</h5>
<ul>
<li>formatNumberResult, dateTimeUTC, showDateTime, capitalize</li>
</ul>
<h5>Example</h5>
<pre class="prettyprint"><code>Ajoute au DOM de la page dans la div .results, la météo de la ville demandée.</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#armstrongNumber">armstrongNumber</a></li><li><a href="global.html#binaryToDecimal">binaryToDecimal</a></li><li><a href="global.html#binaryToHexadecimal">binaryToHexadecimal</a></li><li><a href="global.html#binaryToText">binaryToText</a></li><li><a href="global.html#calculateAge">calculateAge</a></li><li><a href="global.html#capitalize">capitalize</a></li><li><a href="global.html#convertArabicToRoman">convertArabicToRoman</a></li><li><a href="global.html#convertCurrency">convertCurrency</a></li><li><a href="global.html#convertDistance">convertDistance</a></li><li><a href="global.html#convertRomanToArabic">convertRomanToArabic</a></li><li><a href="global.html#convertTemperature">convertTemperature</a></li><li><a href="global.html#createSessionCookie">createSessionCookie</a></li><li><a href="global.html#dateTimeUTC">dateTimeUTC</a></li><li><a href="global.html#decimalToBinary">decimalToBinary</a></li><li><a href="global.html#decimalToHexadecimal">decimalToHexadecimal</a></li><li><a href="global.html#filterStudents">filterStudents</a></li><li><a href="global.html#formatNumberResult">formatNumberResult</a></li><li><a href="global.html#getRandomQuote">getRandomQuote</a></li><li><a href="global.html#hexadecimalToBinary">hexadecimalToBinary</a></li><li><a href="global.html#hexadecimalToDecimal">hexadecimalToDecimal</a></li><li><a href="global.html#hexadecimalToText">hexadecimalToText</a></li><li><a href="global.html#isEmptyValue">isEmptyValue</a></li><li><a href="global.html#isFloat">isFloat</a></li><li><a href="global.html#isValidDate">isValidDate</a></li><li><a href="global.html#numberUnicodeToText">numberUnicodeToText</a></li><li><a href="global.html#randomNumber">randomNumber</a></li><li><a href="global.html#realDateTime">realDateTime</a></li><li><a href="global.html#showDateTime">showDateTime</a></li><li><a href="global.html#stringPermutations">stringPermutations</a></li><li><a href="global.html#textToBinary">textToBinary</a></li><li><a href="global.html#textToHexadecimal">textToHexadecimal</a></li><li><a href="global.html#textToNumberUnicode">textToNumberUnicode</a></li><li><a href="global.html#weatherRequest">weatherRequest</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Nov 11 2019 17:45:44 GMT+0100 (GMT+01:00)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
Copy Permalink