Dynamique.js - Symboles utilisés

Versionnage et symboles

Cette page décrit le fonctionnement du versionnage des fichiers ainsi que les symboles utilisés dans la documentation.

Fonctionnement du versionnage

Le versionnage des différents composants de la librairie suit une écriture commune. Une version s'écrit sous forme de chaine de caractère et selon le format « X.Y » où :

X est le numéro de version primaire, indiquant les évolutions importantes de la composante;
Y est le numéro de version secondaire qui indique si la version primaire associée à subit des corrections.

Est considéré comme évolution importante d’un composant, qui viendrait alors incrémenter X, toutes fonctionnalités ajoutées, supprimées ou modifiées altérant l'utilisation du composant. On parle alors de mise à jour évolutive, le but étant de modifier fondamentalement une ou plusieurs fonctionnalités d'un composant. La mise à jour primaire d'un composant vers une version supérieure peut entrainer une modification du code exploitant le composant. Ainsi, passer d'une composante en version « 1.0 » vers « 2.0 » entrainera possiblement une modification du code l'exploitant. Pour autant, il est possible qu'une évolution primaire n'implique pas de modifier le code source l'exploitant.

Est considéré comme évolution corrective d'une composante, qui viendrait donc incrémenter Y, toutes modifications de fonctionnalités n’impliquant aucun changement dans l'utilisation du composant. On parle alors de mise à jour corrective, le but étant de corriger des bugs ou d’optimiser les performances de certaines fonctionnalités sans en modifier leur usage. La mise à jour secondaire d'un composant vers une version supérieure n'entraine pas de modification du code l'exploitant. Ainsi passer d'une composante en version « 1.0 » vers « 1.2 » n'entrainera aucune modification du code l'exploitant et peut donc être effectuée en toute sécurité.

Le journal d'évolution d'une composante liste ses modifications primaire et secondaire et décrit les contraintes impliquant le passage d'une version à une autre.

Types de variable

: l'élément est un objet [object Object]. Dans certains contextes, il désigne également tout type d'objet dont les tableaux.
: l'élément est un tableau [object Array].
: l'élément est une chaine de caractère de longueur et de contenu libre, si non-précisé.
: l'élément est un booléen.
: l'élément est une fonction.
: l'élément est un nombre de valeur et de précision libre, si non-précisé.
: l'élément peut-être de n'importe quel type, entre autre parmis ceux exposés ci-dessus.

Facultatif: indique que l'élément est facultatif.

Autres symboles

ou (pour Method): indique que l'élément est soit une méthode soit une fonction.
ou (pour Asynchronous): l'élément nécessite de réaliser des opérations asynchrones avant de renvoyer un résultat. Le résultat doit donc être considéré comme une promesse Promise même si l'élément n'en renvoie pas une directement. Il est utilisé lorsque l'élément est préfixé du mot-clef async dans le code source.
ou (pour property): indique que l'élément est une propriété.
ou (pour Read Only): indique que l'élément est accessible en lecture seule uniquement. Il se peut que sa modification génère une erreur mais il n'est pour autant pas assuré que ce comportement soit adopté systématiquement. Il est donc déconseillé de le modifier même si les droits accordés le permettent sous peine de générer un comportement anormal ou des erreurs.
ou (pour Read Write): indique que l'élément est accessible en lecture et en écriture. Sa modification implique un changement de comportement du code auquel il est attaché.