Version class

Pacote:

@microsoft/sp-core-library

Representa um número de versão com duas, três ou quatro partes.

Comentários

Esta classe representa versões que seguem o formato de cadeia de carateres onde MAJOR.MINOR[.PATCH[.REVISION]] as partes MAJOR, MINOR, PATCH e REVISION são números inteiros. PATCH e REVISION são opcionais. São permitidos zero dígitos à esquerda, mas são eliminados. As partes em falta são tratadas como zeros para comparações.

Exemplos: 1.0, , 1.0.0, 1.011.0.0.0, , , 01.02.03001.002.003.004

Propriedades

major	Devolve o primeiro componente da cadeia de versão.
minor	Devolve o segundo componente da cadeia de versão.
patch	O terceiro número na cadeia de versão ou indefinido se não for especificado.
revision	O quarto número na cadeia de versão ou indefinido se não for especificado.

Métodos

compare(v1, v2)	Compara dois objetos de Versão para determinar qual é a versão mais recente.
equals(compareWith)	Testa se esta versão é igual ao parâmetro de entrada.
greaterThan(compareWith)	Testa se esta versão é maior do que (ou seja, mais recente do que) o parâmetro de entrada.
isValid(versionString)	Teste se uma cadeia é um especificador de versão válido.
lessThan(compareWith)	Testa se esta versão é menor do que (ou seja, mais antiga do que) o parâmetro de entrada.
parse(versionString)	Cria uma nova instância de versão usando a cadeia de caracteres de versão. É emitida uma exceção se não for possível analisar a cadeia.
satisfies(compareWith)	Testa se esta versão cumpre os requisitos de compatibilidade da versão de entrada, ou seja, é retrocompatível.
toString()	Devolve uma representação de cadeia da versão.
tryParse(versionString)	Tenta analisar a cadeia de entrada para construir um novo objeto Versão. Se a cadeia de caracteres não puder ser analisada, será retornado indefinido.

Detalhes da propriedade

major

Devolve o primeiro componente da cadeia de versão.

get major(): number;

Valor da propriedade

number

Comentários

Normalmente, uma alteração no número da versão principal indica uma quebra de compatibilidade com versões anteriores.

minor

Devolve o segundo componente da cadeia de versão.

get minor(): number;

Valor da propriedade

number

Comentários

Normalmente, uma alteração no número da versão secundária indica que foram adicionadas novas funcionalidades, mantendo-se retrocompatíveis com as versões anteriores.

patch

O terceiro número na cadeia de versão ou indefinido se não for especificado.

get patch(): number | undefined;

Valor da propriedade

number | undefined

Comentários

Normalmente, uma alteração no número da versão do patch indica uma pequena correção que não afeta o contrato de compatibilidade da biblioteca. Para um objeto .NET System.Version, este é referido como o número "build".

revision

O quarto número na cadeia de versão ou indefinido se não for especificado.

get revision(): number | undefined;

Valor da propriedade

number | undefined

Comentários

Este número não faz parte do padrão Semmantic Versioning (SemVer) utilizado em JavaScript, mas é utilizado por números de versão do .NET.

Detalhes do método

compare(v1, v2)

Compara dois objetos de Versão para determinar qual é a versão mais recente.

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

Parâmetros

v1

Version

A primeira classe de versão para comparação

v2

Version

A classe da segunda versão para comparação

Retornos

number

-1 se a primeira entrada for inferior à segunda entrada; 0 se a primeira entrada for igual à segunda entrada; 1 se a primeira entrada for maior do que a segunda entrada.

equals(compareWith)

Testa se esta versão é igual ao parâmetro de entrada.

equals(compareWith: Version): boolean;

Parâmetros

compareWith

Version

A versão para comparar com

Retornos

boolean

Um booliano que indica se esta versão é igual ao parâmetro de entrada

Comentários

Exemplos:

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)

Testa se esta versão é maior do que (ou seja, mais recente do que) o parâmetro de entrada.

greaterThan(compareWith: Version): boolean;

Parâmetros

compareWith

Version

A versão para comparar com

Retornos

boolean

Um booliano que indica se esta versão é maior que o parâmetro de entrada

Comentários

Exemplos:

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

isValid(versionString)

Teste se uma cadeia é um especificador de versão válido.

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

Parâmetros

versionString

string | undefined | null

A cadeia de caracteres de versão

Retornos

boolean

true se versionString for um especificador de versão válido

lessThan(compareWith)

Testa se esta versão é menor do que (ou seja, mais antiga do que) o parâmetro de entrada.

lessThan(compareWith: Version): boolean;

Parâmetros

compareWith

Version

A versão para comparar com

Retornos

boolean

Um booliano que indica se esta versão é menor que o parâmetro de entrada

Comentários

Exemplos:

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)

Cria uma nova instância de versão usando a cadeia de caracteres de versão. É emitida uma exceção se não for possível analisar a cadeia.

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

Parâmetros

versionString

string | undefined | null

Uma cadeia de caracteres de versão

Retornos

Version

um novo objeto Versão

satisfies(compareWith)

Testa se esta versão cumpre os requisitos de compatibilidade da versão de entrada, ou seja, é retrocompatível.

satisfies(compareWith: Version): boolean;

Parâmetros

compareWith

Version

A versão para comparar com

Retornos

boolean

Um booleano que indica se esta versão é compatível com o parâmetro de entrada

Comentários

Para satisfazer os requisitos de compatibilidade, este objeto tem de ter o mesmo número de versão principal que o parâmetro de entrada e NÃO deve ser mais antigo do que o parâmetro de entrada.

Exemplos:

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

Devolve uma representação de cadeia da versão.

toString(): string;

Retornos

string

Comentários

O valor é normalizado e pode ser diferente da cadeia original (por exemplo, zeros à esquerda podem ser removidos). No entanto, o número de partes da versão não será alterado.

tryParse(versionString)

Tenta analisar a cadeia de entrada para construir um novo objeto Versão. Se a cadeia de caracteres não puder ser analisada, será retornado indefinido.

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

Parâmetros

versionString

string | undefined | null

Uma cadeia de caracteres de versão

Retornos

Version | undefined

O objeto Versão ou indefinido se não for possível analisar a cadeia.