Share via

Version class

  • Referencia
Paquete:
@microsoft/sp-core-library

Representa un número de versión con dos, tres o cuatro partes.

Comentarios

Esta clase representa versiones que siguen el formato de cadena de MAJOR.MINOR[.PATCH[.REVISION]] donde las partes MAJOR, MINOR, PATCH y REVISION son enteros. PATCH y REVISION son opcionales. Se permiten dígitos cero a la izquierda, pero se descartan. Las partes que faltan se tratan como ceros para las comparaciones.

Ejemplos: 1.0, 1.0.0, , 1.011.0.0.0, , , 01.02.03001.002.003.004

Propiedades

major

Devuelve el primer componente de la cadena de versión.
minor

Devuelve el segundo componente de la cadena de versión.
patch

Tercer número de la cadena de versión, o no definido si no se especifica.
revision

Cuarto número de la cadena de versión, o no definido si no se especifica.

Métodos

compare(v1, v2)

Compara dos objetos Version para determinar qué versión es más reciente.
equals(compareWith)

Comprueba si esta versión es igual al parámetro de entrada.
greaterThan(compareWith)

Comprueba si esta versión es mayor que (es decir, más reciente que) el parámetro de entrada.
isValid(versionString)

Pruebe si una cadena es un especificador de versión válido.
lessThan(compareWith)

Comprueba si esta versión es menor que (es decir, anterior a) el parámetro de entrada.
parse(versionString)

Crea una nueva instancia de versión mediante la cadena de versión. Se produce una excepción si no se puede analizar la cadena.
satisfies(compareWith)

Comprueba si esta versión cumple los requisitos de compatibilidad de la versión de entrada, es decir, es compatible con versiones anteriores.
toString()

Devuelve una representación de cadena de la versión.
tryParse(versionString)

Intenta analizar la cadena de entrada para construir un nuevo objeto Version. Si no se puede analizar la cadena, se devuelve undefined.

Detalles de las propiedades

major

Devuelve el primer componente de la cadena de versión.

get major(): number;

Valor de propiedad

number

Comentarios

Normalmente, un cambio en el número de versión principal indica un salto de compatibilidad con versiones anteriores.

minor

Devuelve el segundo componente de la cadena de versión.

get minor(): number;

Valor de propiedad

number

Comentarios

Normalmente, un cambio en el número de versión secundaria indica que se agregaron nuevas características, mientras que permanecen compatibles con versiones anteriores.

patch

Tercer número de la cadena de versión, o no definido si no se especifica.

get patch(): number | undefined;

Valor de propiedad

number | undefined

Comentarios

Normalmente, un cambio en el número de versión de revisión indica una pequeña corrección que no afecta al contrato de compatibilidad de la biblioteca. Para un objeto System.Version de .NET, esto se conoce como el número de "compilación".

revision

Cuarto número de la cadena de versión, o no definido si no se especifica.

get revision(): number | undefined;

Valor de propiedad

number | undefined

Comentarios

Este número no forma parte del estándar de control de versiones semántico (SemVer) usado en JavaScript, pero lo usan los números de versión de .NET.

Detalles del método

compare(v1, v2)

Compara dos objetos Version para determinar qué versión es más reciente.

static compare(v1: Version, v2: Version): number;

Parámetros

v1
Version

La primera clase de versión para la comparación

v2
Version

Segunda clase de versión para la comparación

Devoluciones

number

-1 si la primera entrada es menor que la segunda entrada; 0 si la primera entrada es igual a la segunda entrada; 1 si la primera entrada es mayor que la segunda entrada.

equals(compareWith)

Comprueba si esta versión es igual al parámetro de entrada.

equals(compareWith: Version): boolean;

Parámetros

compareWith
Version

Versión con la que se compara.

Devoluciones

boolean

Booleano que indica si esta versión es igual al parámetro de entrada.

Comentarios

Ejemplos:

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)

Comprueba si esta versión es mayor que (es decir, más reciente que) el parámetro de entrada.

greaterThan(compareWith: Version): boolean;

Parámetros

compareWith
Version

Versión con la que se compara.

Devoluciones

boolean

Booleano que indica si esta versión es mayor que el parámetro de entrada.

Comentarios

Ejemplos:

1.0.0 greaterThan 0.0.9 -> true;
2.0   greaterThan 2.0.0 -> false;
3.0.1 greaterThan 3.0   -> true

isValid(versionString)

Pruebe si una cadena es un especificador de versión válido.

static isValid(versionString: string | undefined | null): boolean;

Parámetros

versionString

string | undefined | null

Cadena de versión.

Devoluciones

boolean

true si versionString es un especificador de versión válido

lessThan(compareWith)

Comprueba si esta versión es menor que (es decir, anterior a) el parámetro de entrada.

lessThan(compareWith: Version): boolean;

Parámetros

compareWith
Version

Versión con la que se compara.

Devoluciones

boolean

Booleano que indica si esta versión es menor que el parámetro de entrada.

Comentarios

Ejemplos:

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)

Crea una nueva instancia de versión mediante la cadena de versión. Se produce una excepción si no se puede analizar la cadena.

static parse(versionString: string | undefined | null): Version;

Parámetros

versionString

string | undefined | null

Cadena de versión.

Devoluciones

Version

un nuevo objeto Version

satisfies(compareWith)

Comprueba si esta versión cumple los requisitos de compatibilidad de la versión de entrada, es decir, es compatible con versiones anteriores.

satisfies(compareWith: Version): boolean;

Parámetros

compareWith
Version

Versión con la que se compara.

Devoluciones

boolean

Un valor booleano que indica si esta versión es compatible con el parámetro de entrada.

Comentarios

Para satisfacer los requisitos de compatibilidad, este objeto debe tener el mismo número de versión principal que el parámetro de entrada y NO debe ser anterior al parámetro de entrada.

Ejemplos:

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()

Devuelve una representación de cadena de la versión.

toString(): string;

Devoluciones

string

Comentarios

El valor se normaliza y puede ser diferente de la cadena original (por ejemplo, se pueden quitar ceros iniciales). Sin embargo, el número de elementos de versión no cambiará.

tryParse(versionString)

Intenta analizar la cadena de entrada para construir un nuevo objeto Version. Si no se puede analizar la cadena, se devuelve undefined.

static tryParse(versionString: string | undefined | null): Version | undefined;

Parámetros

versionString

string | undefined | null

Cadena de versión.

Devoluciones

Version | undefined

Objeto Version o indefinido si no se pudo analizar la cadena.