Version class
Представляет номер версии с двумя, тремя или четырьмя частями.
Комментарии
Этот класс представляет версии, которые соответствуют формату строки MAJOR.MINOR[.PATCH[.REVISION]] , где части MAJOR, MINOR, PATCH и REVISION являются целыми числами. Параметры PATCH и REVISION — необязательные. Начальные нулевые цифры разрешены, но они отбрасываются. Отсутствующие части обрабатываются как нули для сравнения.
Примеры: 1.0, 1.0.0, 1.0.0.0, 1.01, 01.02.03, 001.002.003.004
Свойства
| major | Возвращает первый компонент строки версии. |
| minor | Возвращает второй компонент строки версии. |
| patch | Третий номер в строке версии или неопределенный, если он не указан. |
| revision | Четвертое число в строке версии или неопределенное, если не указано. |
Методы
| compare(v1, v2) | Сравнивает два объекта Version, чтобы определить, какая версия является более новой. |
| equals(compare |
Проверяет, равна ли эта версия входным параметру. |
| greater |
Проверяет, больше ли эта версия (т. е. новее) входного параметра. |
| is |
Проверьте, является ли строка допустимым описателем версии. |
| less |
Проверяет, является ли эта версия меньше (т. е. старше) входного параметра. |
| parse(version |
Создает новый экземпляр Version с помощью строки версии. Если не удается проанализировать строку, возникает исключение. |
| satisfies(compare |
Проверяет, соответствует ли эта версия требованиям совместимости входной версии, т. е. является ли она обратной совместимостью. |
| to |
Возвращает строковое представление версии. |
| try |
Пытается проанализировать входную строку для создания нового объекта Version. Если проанализировать строку не удается, возвращается неопределенное значение. |
Сведения о свойстве
major
Возвращает первый компонент строки версии.
get major(): number;Значение свойства
number
Комментарии
Обычно изменение основного номера версии указывает на разрыв совместимости с предыдущими версиями.
minor
Возвращает второй компонент строки версии.
get minor(): number;Значение свойства
number
Комментарии
Как правило, изменение номера дополнительной версии указывает на то, что добавлены новые функции, сохраняя обратную совместимость с предыдущими выпусками.
patch
Третий номер в строке версии или неопределенный, если он не указан.
get patch(): number | undefined;Значение свойства
number | undefined
Комментарии
Как правило, изменение номера версии исправления указывает на небольшое исправление, которое не влияет на контракт совместимости для библиотеки. Для объекта .NET System.Version это называется номером сборки.
revision
Четвертое число в строке версии или неопределенное, если не указано.
get revision(): number | undefined;Значение свойства
number | undefined
Комментарии
Это число не является частью стандарта семантического управления версиями (SemVer), используемого в JavaScript, но оно используется номерами версий .NET.
Сведения о методе
compare(v1, v2)
Сравнивает два объекта Version, чтобы определить, какая версия является более новой.
static compare(v1: Version, v2: Version): number;Параметры
- v1
- Version
Первый класс версий для сравнения
- v2
- Version
Второй класс версий для сравнения
Возвращаемое значение
number
-1, если первый вход меньше второго; 0, если первый вход равен второму входу; Значение 1, если первый вход больше второго.
equals(compareWith)
Проверяет, равна ли эта версия входным параметру.
equals(compareWith: Version): boolean;Параметры
- compareWith
- Version
Версия для сравнения
Возвращаемое значение
boolean
Логическое значение, указывающее, равен ли номер версии входному параметру.
Комментарии
Примеры:
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)
Проверяет, больше ли эта версия (т. е. новее) входного параметра.
greaterThan(compareWith: Version): boolean;Параметры
- compareWith
- Version
Версия для сравнения
Возвращаемое значение
boolean
Логическое значение, указывающее, превышает ли номер этой версии значение входного параметра.
Комментарии
Примеры:
1.0.0 greaterThan 0.0.9 -> true;
2.0 greaterThan 2.0.0 -> false;
3.0.1 greaterThan 3.0 -> true
isValid(versionString)
Проверьте, является ли строка допустимым описателем версии.
static isValid(versionString: string | undefined | null): boolean;Параметры
- versionString
-
string | undefined | null
Строка версии
Возвращаемое значение
boolean
Значение true, если versionString является допустимым описателем версии.
lessThan(compareWith)
Проверяет, является ли эта версия меньше (т. е. старше) входного параметра.
lessThan(compareWith: Version): boolean;Параметры
- compareWith
- Version
Версия для сравнения
Возвращаемое значение
boolean
Логическое значение, указывающее, ниже ли номер этой версии, чем значение входного параметра.
Комментарии
Примеры:
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)
Создает новый экземпляр Version с помощью строки версии. Если не удается проанализировать строку, возникает исключение.
static parse(versionString: string | undefined | null): Version;Параметры
- versionString
-
string | undefined | null
Строка версии
Возвращаемое значение
новый объект Version
satisfies(compareWith)
Проверяет, соответствует ли эта версия требованиям совместимости входной версии, т. е. является ли она обратной совместимостью.
satisfies(compareWith: Version): boolean;Параметры
- compareWith
- Version
Версия для сравнения
Возвращаемое значение
boolean
Логическое значение, указывающее, совместима ли эта версия с входным параметром
Комментарии
Чтобы удовлетворить требования к совместимости, этот объект должен иметь тот же основной номер версии, что и входной параметр, и он не должен быть старше входного параметра.
Примеры:
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()
Возвращает строковое представление версии.
toString(): string;Возвращаемое значение
string
Комментарии
Значение нормализуется и может отличаться от исходной строки (например, начальные нули могут быть удалены). Однако количество частей версии будет неизменным.
tryParse(versionString)
Пытается проанализировать входную строку для создания нового объекта Version. Если проанализировать строку не удается, возвращается неопределенное значение.
static tryParse(versionString: string | undefined | null): Version | undefined;Параметры
- versionString
-
string | undefined | null
Строка версии
Возвращаемое значение
Version | undefined
Объект Version или undefined, если не удалось проанализировать строку.