Version class
Représente un numéro de version avec deux, trois ou quatre parties.
Remarques
Cette classe représente les versions qui suivent le format de chaîne où MAJOR.MINOR[.PATCH[.REVISION]] les parties MAJOR, MINOR, PATCH et REVISION sont des entiers. PATCH et REVISION sont facultatifs. Les chiffres zéro non significatifs sont autorisés, mais ils sont ignorés. Les parties manquantes sont traitées comme des zéros pour les comparaisons.
Exemples : 1.0, 1.0.0, 1.0.0.0, 1.01, 01.02.03, 001.002.003.004
Propriétés
| major | Retourne le premier composant de la chaîne de version. |
| minor | Retourne le deuxième composant de la chaîne de version. |
| patch | Troisième nombre dans la chaîne de version, ou non défini s’il n’est pas spécifié. |
| revision | Quatrième nombre dans la chaîne de version, ou non défini s’il n’est pas spécifié. |
Méthodes
| compare(v1, v2) | Compare deux objets Version pour déterminer la version la plus récente. |
| equals(compare |
Teste si cette version est égale au paramètre d’entrée. |
| greater |
Teste si cette version est supérieure au paramètre d’entrée (c’est-à-dire plus récente que). |
| is |
Testez si une chaîne est un spécificateur de version valide. |
| less |
Teste si cette version est inférieure (c’est-à-dire antérieure) au paramètre d’entrée. |
| parse(version |
Crée une nouvelle instance Version à l’aide de la chaîne de version. Une exception est levée si la chaîne ne peut pas être analysée. |
| satisfies(compare |
Teste si cette version répond aux exigences de compatibilité de la version d’entrée, c’est-à-dire qu’elle est à compatibilité descendante. |
| to |
Retourne une représentation sous forme de chaîne de la version. |
| try |
Tente d’analyser la chaîne d’entrée pour construire un nouvel objet Version. Si la chaîne ne peut pas être analysée, « Undefined » est renvoyé. |
Détails de la propriété
major
Retourne le premier composant de la chaîne de version.
get major(): number;Valeur de propriété
number
Remarques
En règle générale, une modification du numéro de version principale indique une rupture de compatibilité avec les versions précédentes.
minor
Retourne le deuxième composant de la chaîne de version.
get minor(): number;Valeur de propriété
number
Remarques
En règle générale, une modification du numéro de version mineure indique que de nouvelles fonctionnalités ont été ajoutées, tout en restant rétrocompatible avec les versions précédentes.
patch
Troisième nombre dans la chaîne de version, ou non défini s’il n’est pas spécifié.
get patch(): number | undefined;Valeur de propriété
number | undefined
Remarques
En règle générale, une modification du numéro de version du correctif indique un petit correctif qui n’affecte pas le contrat de compatibilité de la bibliothèque. Pour un objet .NET System.Version, il s’agit du numéro « build ».
revision
Quatrième nombre dans la chaîne de version, ou non défini s’il n’est pas spécifié.
get revision(): number | undefined;Valeur de propriété
number | undefined
Remarques
Ce numéro ne fait pas partie de la norme SemVer (Semantic Versioning) utilisée dans JavaScript, mais il est utilisé par les numéros de version .NET.
Détails de la méthode
compare(v1, v2)
Compare deux objets Version pour déterminer la version la plus récente.
static compare(v1: Version, v2: Version): number;Paramètres
- v1
- Version
Première classe de version pour la comparaison
- v2
- Version
Deuxième classe de version à des fins de comparaison
Retours
number
-1 si la première entrée est inférieure à la deuxième entrée ; 0 si la première entrée est égale à la deuxième entrée ; 1 si la première entrée est supérieure à la deuxième entrée.
equals(compareWith)
Teste si cette version est égale au paramètre d’entrée.
equals(compareWith: Version): boolean;Paramètres
- compareWith
- Version
Version à comparer à
Retours
boolean
Valeur booléenne indiquant si cette version est égale au paramètre d’entrée
Remarques
Exemples :
1.0.0 equals 1.0.0 -> true;
2.0.1 equals 2.0.0 -> false;
3.0 equals 3.0.0 -> true;
04.01 equals 4.1 -> true
greaterThan(compareWith)
Teste si cette version est supérieure au paramètre d’entrée (c’est-à-dire plus récente que).
greaterThan(compareWith: Version): boolean;Paramètres
- compareWith
- Version
Version à comparer à
Retours
boolean
Valeur booléenne indiquant si cette version est supérieure au paramètre d’entrée
Remarques
Exemples :
1.0.0 greaterThan 0.0.9 -> true;
2.0 greaterThan 2.0.0 -> false;
3.0.1 greaterThan 3.0 -> true
isValid(versionString)
Testez si une chaîne est un spécificateur de version valide.
static isValid(versionString: string | undefined | null): boolean;Paramètres
- versionString
-
string | undefined | null
Chaîne de version
Retours
boolean
true si versionString est un spécificateur de version valide
lessThan(compareWith)
Teste si cette version est inférieure (c’est-à-dire antérieure) au paramètre d’entrée.
lessThan(compareWith: Version): boolean;Paramètres
- compareWith
- Version
Version à comparer à
Retours
boolean
Valeur booléenne indiquant si cette version est inférieure au paramètre d’entrée
Remarques
Exemples :
0.9.9 lessThan 1.0.0 -> true;
2.0 lessThan 2.0.0 -> false;
3.0 lessThan 3.0.1 -> true;
04.01 lessThan 4.1 -> false
parse(versionString)
Crée une nouvelle instance Version à l’aide de la chaîne de version. Une exception est levée si la chaîne ne peut pas être analysée.
static parse(versionString: string | undefined | null): Version;Paramètres
- versionString
-
string | undefined | null
Chaîne de version
Retours
un nouvel objet Version
satisfies(compareWith)
Teste si cette version répond aux exigences de compatibilité de la version d’entrée, c’est-à-dire qu’elle est à compatibilité descendante.
satisfies(compareWith: Version): boolean;Paramètres
- compareWith
- Version
Version à comparer à
Retours
boolean
Valeur booléenne indiquant si cette version est compatible avec le paramètre d’entrée
Remarques
Pour répondre aux exigences de compatibilité, cet objet doit avoir le même numéro de version principal que le paramètre d’entrée et il ne doit PAS être antérieur au paramètre d’entrée.
Exemples :
1.0.0 satisfies 1.0.0 -> true;
1.1.0 satisfies 1.0.0 -> true;
2.0.0 satisfies 1.0.0 -> false;
1.0.0 satisfies 1.1.0 -> false
toString()
Retourne une représentation sous forme de chaîne de la version.
toString(): string;Retours
string
Remarques
La valeur est normalisée et peut être différente de la chaîne d’origine (par exemple, les zéros non significatifs peuvent être supprimés). Toutefois, le nombre de parties de version reste inchangé.
tryParse(versionString)
Tente d’analyser la chaîne d’entrée pour construire un nouvel objet Version. Si la chaîne ne peut pas être analysée, « Undefined » est renvoyé.
static tryParse(versionString: string | undefined | null): Version | undefined;Paramètres
- versionString
-
string | undefined | null
Chaîne de version
Retours
Version | undefined
Objet Version, ou non défini si la chaîne n’a pas pu être analysée.