Semver

https://semver-nuget.org/v3.0.x/
Admin
A .Net library to create, parse, and manipulate semantic version numbers with the `SemVersion` class...
Tokens:34,802
Snippets:352
Trust Score:4.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install SemVer NuGet Package

Source: https://semver-nuget.org/v3.0.x/index.html

Use this command in the NuGet Package Manager Console to install the semver library.

```powershell
Install-Package semver

```

--------------------------------

### UnbrokenSemVersionRange Start Property

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Gets the start (minimum) version of the range. This can be null for ranges with no lower bound.

```csharp
public SemVersion Start { get; }
```

--------------------------------

### InclusiveOfStart

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Constructs a version range that includes versions greater than or equal to the start version and less than the end version. Optionally includes all prerelease versions.

```APIDOC
## InclusiveOfStart(SemVersion start, SemVersion end, Boolean includeAllPrerelease)

### Description
Construct a range containing all versions between the given versions including the start but not the end.

### Method
static UnbrokenSemVersionRange

### Parameters
#### Path Parameters
- **start** (SemVersion) - Required - The range will contain only versions greater than or equal to this.
- **end** (SemVersion) - Required - The range will contain only versions less than this.
- **includeAllPrerelease** (System.Boolean) - Optional - Include all prerelease versions in the range rather than just those matching the given versions if they are prerelease.

### Returns
#### Success Response
- **UnbrokenSemVersionRange** - A range containing versions between the given versions including the start but not the end.
```

--------------------------------

### Create an inclusive version range

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Construct a range that includes all versions between two specified SemVersions, inclusive of both start and end. Prerelease versions can be included.

```csharp
public static UnbrokenSemVersionRange Inclusive(SemVersion start, SemVersion end, bool includeAllPrerelease = false)
```

--------------------------------

### Constructing an UnbrokenSemVersionRange (Inclusive of Start)

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Creates a version range that includes versions greater than or equal to 'start' and less than 'end'. Optionally includes all prerelease versions.

```C#
public static UnbrokenSemVersionRange InclusiveOfStart(SemVersion start, SemVersion end, bool includeAllPrerelease = false)
```

--------------------------------

### Prerelease Property

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Gets the prerelease identifiers as a string. This is empty for release versions.

```csharp
public string Prerelease { get; }
```

--------------------------------

### UnbrokenSemVersionRange StartInclusive Property

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Indicates whether the Start version is included in the range. This will always be false if the Start version is null.

```csharp
public bool StartInclusive { get; }
```

--------------------------------

### Create Inclusive SemVersionRange

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Constructs a range containing all versions between the start and end versions, inclusive of both. Optionally includes prerelease versions.

```csharp
public static SemVersionRange Inclusive(SemVersion start, SemVersion end, bool includeAllPrerelease = false)
```

--------------------------------

### Construct Range Inclusive of Start

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Creates a version range that includes the start version but excludes the end version. Use this when the upper bound is exclusive.

```csharp
public static SemVersionRange InclusiveOfStart(SemVersion start, SemVersion end, bool includeAllPrerelease = false)
```

--------------------------------

### Constructing an UnbrokenSemVersionRange (Exclusive of Start)

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Creates a version range that includes versions greater than 'start' and less than or equal to 'end'. Optionally includes all prerelease versions.

```C#
public static UnbrokenSemVersionRange Create(SemVersion start, SemVersion end, bool includeAllPrerelease = false)
```

--------------------------------

### InclusiveOfEnd

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Constructs a version range that includes versions greater than or equal to the start version and less than or equal to the end version. Optionally includes all prerelease versions.

```APIDOC
## InclusiveOfEnd

### Description
Constructs a range containing all versions between the given versions including the end but not the start.

### Method
`public static SemVersionRange InclusiveOfEnd(SemVersion start, SemVersion end, bool includeAllPrerelease = false)`

### Parameters
#### Path Parameters
- **start** (SemVersion) - Required - The range will contain only versions greater than this.
- **end** (SemVersion) - Required - The range will contain only versions less than or equal to this.
- **includeAllPrerelease** (Boolean) - Optional - Include all prerelease versions in the range rather than just those matching the given versions if they are prerelease.

### Returns
#### Success Response
- **SemVersionRange** - A range containing versions between the given versions including the end but not the start.
```

--------------------------------

### UnbrokenSemVersionRange IncludeAllPrerelease Property

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Determines if all prerelease versions between the Start and End are included. If false, only prereleases matching the Start or End version are included if those ends are prereleases.

```csharp
public bool IncludeAllPrerelease { get; }
```

--------------------------------

### Create an inclusive-of-end version range

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Construct a range that includes all versions between two specified SemVersions, inclusive of the end version but exclusive of the start version. Prerelease versions can be included.

```csharp
public static UnbrokenSemVersionRange InclusiveOfEnd(SemVersion start, SemVersion end, bool includeAllPrerelease = false)
```

--------------------------------

### Construct Range Inclusive of End

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Creates a version range that includes the end version but excludes the start version. Use this when the lower bound is exclusive.

```csharp
public static SemVersionRange InclusiveOfEnd(SemVersion start, SemVersion end, bool includeAllPrerelease = false)
```

--------------------------------

### Construct SemVersion Objects

Source: https://semver-nuget.org/v3.0.x/index.html

Demonstrates constructing SemVersion objects using constructors and a static parsed method.

```csharp
var v1 = new SemVersion(1, 0);
var vNextRc = SemVersion.ParsedFrom(1, 1, 0, "rc.1");

```

--------------------------------

### Create SemVersion with Prerelease Identifiers (IEnumerable<String>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a new SemVersion instance by replacing existing prerelease identifiers with a provided collection of strings. The input strings must be valid prerelease identifiers, and the collection must not be null.

```csharp
public SemVersion WithPrerelease(IEnumerable<string> prereleaseIdentifiers)
```

--------------------------------

### Create SemVersion with Prerelease Identifiers (String, String[])

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a new SemVersion instance by replacing existing prerelease identifiers with a primary identifier and an array of subsequent identifiers. Ensure all provided identifiers are valid and not null.

```csharp
public SemVersion WithPrerelease(string prereleaseIdentifier, params string[] prereleaseIdentifiers)
```

--------------------------------

### Create SemVersion with new build metadata identifiers (IEnumerable<String>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Use the WithMetadata overload that accepts a collection of strings to create a new SemVersion instance with updated build metadata. Each string in the collection will be parsed as a metadata identifier. Ensure strings are valid and not null.

```csharp
public SemVersion WithMetadata(IEnumerable<string> metadataIdentifiers)
```

--------------------------------

### Construct SemVersion with Full Components

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Constructs a new SemVersion instance with all components: major, minor, patch, prerelease identifiers, and metadata identifiers. The major, minor, and patch numbers cannot be negative. Prerelease or metadata identifiers cannot have default values.

```csharp
public SemVersion(BigInteger major, BigInteger minor = null, BigInteger patch = null, IEnumerable<PrereleaseIdentifier> prerelease = null, IEnumerable<MetadataIdentifier> metadata = null)
```

--------------------------------

### GetHashCode()

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Gets a hash code for this instance.

```APIDOC
## GetHashCode()

### Description
Gets a hash code for this instance.

### Method
`public override int GetHashCode()`

### Returns
#### Success Response
- **A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.** (System.Int32)
```

--------------------------------

### ComparePrecedenceTo

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Compares two SemVersion objects to determine their precedence order. Versions with the same precedence but different build metadata are considered equal in precedence.

```APIDOC
## ComparePrecedenceTo(SemVersion)

### Description
Compares two versions and indicates whether this instance precedes, follows, or is in the same position as the other in the precedence order. Versions that differ only by build metadata have the same precedence.

### Method Signature
```csharp
public int ComparePrecedenceTo(SemVersion other)
```

### Parameters
#### Path Parameters
- **other** (SemVersion) - The SemVersion to compare against.

### Returns
An integer that indicates whether this instance precedes, follows, or is in the same position as `other` in the precedence order.
- **-1**: This instance precedes `other` in the precedence order.
- **0**: This instance has the same precedence as `other`.
- **1**: This instance follows `other` in the precedence order or `other` is null.
```

--------------------------------

### GetHashCode()

Source: https://semver-nuget.org/v3.0.x/Semver.MetadataIdentifier.html

Gets a hash code for this identifier.

```APIDOC
## GetHashCode()

### Description
Gets a hash code for this identifier.

### Returns
- **System.Int32**: A hash code for this identifier.
```

--------------------------------

### Any Style

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionStyles.html

Accepts any version string format currently supported by the parser. This may change as new formats are added.

```csharp
public const SemVersionStyles Any
```

--------------------------------

### Create SemVersion with Prerelease Identifiers (IEnumerable<PrereleaseIdentifier>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a new SemVersion instance by replacing existing prerelease identifiers with a provided collection of PrereleaseIdentifier objects. Ensure the input collection is not null.

```csharp
public SemVersion WithPrerelease(IEnumerable<PrereleaseIdentifier> prereleaseIdentifiers)
```

--------------------------------

### SemVersionRange.Count Property

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Gets the number of unbroken ranges that constitute this SemVersionRange.

```csharp
public int Count { get; }
```

--------------------------------

### Get Enumerator for UnbrokenSemVersionRanges

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Provides an enumerator to iterate through the UnbrokenSemVersionRanges that constitute this version range.

```csharp
public IEnumerator<UnbrokenSemVersionRange> GetEnumerator()
```

--------------------------------

### Create SemVersion with new build metadata identifiers (String, String[])

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Use this WithMetadata overload to create a new SemVersion instance with updated build metadata by providing a primary identifier and an array of additional identifiers. This is a flexible way to set build metadata from string representations.

```csharp
public SemVersion WithMetadata(string metadataIdentifier, params string[] metadataIdentifiers)
```

--------------------------------

### UnbrokenSemVersionRange.Empty

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Gets a static UnbrokenSemVersionRange representing an empty range, which contains no SemVersion values.

```APIDOC
## UnbrokenSemVersionRange.Empty

### Description
Gets a static UnbrokenSemVersionRange representing an empty range, which contains no SemVersion values.

### Remarks
There are an infinite number of ways to represent the empty range. Any range where the start is greater than the end or where start equals end but one is not inclusive would be empty. See https://en.wikipedia.org/wiki/Interval_(mathematics)#Classification_of_intervals
Since there is no maximum version the only unique empty range is `<0.0.0-0`.

### Property Value
- **Type**: UnbrokenSemVersionRange
- **Description**: A standard representation for the empty range that contains no versions.
```

--------------------------------

### SemVersionRange.All Property

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Represents a range that includes all release and prerelease versions.

```csharp
public static SemVersionRange All { get; }
```

--------------------------------

### SemVersion Constructors

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Provides documentation for the various constructors of the SemVersion class, allowing for the creation of semantic version objects with different levels of detail.

```APIDOC
## SemVersion(BigInteger major)

### Description
Constructs a new instance of the SemVersion class with a specified major version.

### Method
Constructor

### Parameters
- **major** (BigInteger) - Required - The major version number.

### Exceptions
- **System.ArgumentOutOfRangeException** - The `major` version number is negative.
```

```APIDOC
## SemVersion(BigInteger major, BigInteger minor)

### Description
Constructs a new instance of the SemVersion class with specified major and minor versions.

### Method
Constructor

### Parameters
- **major** (BigInteger) - Required - The major version number.
- **minor** (BigInteger) - Required - The minor version number.

### Exceptions
- **System.ArgumentOutOfRangeException** - The `major` or `minor` version number is negative.
```

```APIDOC
## SemVersion(BigInteger major, BigInteger minor, BigInteger patch)

### Description
Constructs a new instance of the SemVersion class with specified major, minor, and patch versions.

### Method
Constructor

### Parameters
- **major** (BigInteger) - Required - The major version number.
- **minor** (BigInteger) - Required - The minor version number.
- **patch** (BigInteger) - Required - The patch version number.

### Exceptions
- **System.ArgumentOutOfRangeException** - The `major`, `minor`, or `patch` version number is negative.
```

```APIDOC
## SemVersion(BigInteger major, BigInteger minor, BigInteger patch, IEnumerable<PrereleaseIdentifier> prerelease, IEnumerable<MetadataIdentifier> metadata)

### Description
Constructs a new instance of the SemVersion class with specified major, minor, patch, prerelease identifiers, and build metadata.

### Method
Constructor

### Parameters
- **major** (BigInteger) - Required - The major version number.
- **minor** (BigInteger) - Optional - The minor version number.
- **patch** (BigInteger) - Optional - The patch version number.
- **prerelease** (IEnumerable<PrereleaseIdentifier>) - Optional - The prerelease identifiers.
- **metadata** (IEnumerable<MetadataIdentifier>) - Optional - The build metadata identifiers.

### Exceptions
- **System.ArgumentOutOfRangeException** - The `major`, `minor`, or `patch` version number is negative.
- **System.ArgumentException** - A prerelease or metadata identifier has the default value.
```

```APIDOC
## SemVersion(BigInteger major, BigInteger minor, BigInteger patch, IEnumerable<String> prerelease, IEnumerable<String> metadata)

### Description
Constructs a new instance of the SemVersion class with specified major, minor, patch, prerelease identifiers (as strings), and build metadata (as strings).

### Method
Constructor

### Parameters
- **major** (BigInteger) - Required - The major version number.
- **minor** (BigInteger) - Optional - The minor version number.
- **patch** (BigInteger) - Optional - The patch version number.
- **prerelease** (IEnumerable<string>) - Optional - The prerelease identifiers.
- **metadata** (IEnumerable<string>) - Optional - The build metadata identifiers.

### Exceptions
- **System.ArgumentOutOfRangeException** - The `major`, `minor`, or `patch` version number is negative.
- **System.ArgumentNullException** - One of the prerelease or metadata identifiers is null.
- **System.ArgumentException** - A prerelease identifier is empty or contains invalid characters, or has leading zeros for a numeric identifier. Or, a metadata identifier is empty or contains invalid characters.
```

--------------------------------

### UnbrokenSemVersionRange.All

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Gets a static UnbrokenSemVersionRange that includes all possible SemVersion values, both release and prerelease.

```APIDOC
## UnbrokenSemVersionRange.All

### Description
Gets a static UnbrokenSemVersionRange that includes all possible SemVersion values, both release and prerelease.

### Property Value
- **Type**: UnbrokenSemVersionRange
- **Description**: The range that contains both all release and prerelease versions.
```

--------------------------------

### Create SemVersion with Parsed Prerelease String

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a new SemVersion instance with a prerelease portion parsed from a string. Optionally allows leading zeros in numeric identifiers, though they will be removed in the resulting PrereleaseIdentifier.

```csharp
public SemVersion WithPrereleaseParsedFrom(string prerelease, bool allowLeadingZeros = false)
```

--------------------------------

### UnbrokenSemVersionRange.AllRelease

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Gets a static UnbrokenSemVersionRange that includes all release SemVersion values, excluding prerelease versions.

```APIDOC
## UnbrokenSemVersionRange.AllRelease

### Description
Gets a static UnbrokenSemVersionRange that includes all release SemVersion values, excluding prerelease versions.

### Property Value
- **Type**: UnbrokenSemVersionRange
- **Description**: The range that contains all release versions but no prerelease versions.
```

--------------------------------

### GetHashCode()

Source: https://semver-nuget.org/v3.0.x/Semver.PrereleaseIdentifier.html

Gets a hash code for this PrereleaseIdentifier. Numeric identifiers with leading zeros will have the same hash code.

```APIDOC
## GetHashCode()

### Description
Gets a hash code for this identifier.

### Method
```
public override int GetHashCode()
```

### Returns
- **System.Int32** - A hash code for this identifier.

### Remarks
Numeric identifiers with leading zeros do have the same hash code (e.g. '`15`' has the same hash code as '`015`').
```

--------------------------------

### WithPrerelease

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with different prerelease identifiers.

```APIDOC
## WithPrerelease(PrereleaseIdentifier, PrereleaseIdentifier[])

### Description
Creates a copy of the current instance with different prerelease identifiers.

### Method Signature
```csharp
public SemVersion WithPrerelease(PrereleaseIdentifier prereleaseIdentifier, params PrereleaseIdentifier[] prereleaseIdentifiers)
```

### Parameters
#### Path Parameters
- **prereleaseIdentifier** (PrereleaseIdentifier) - Description: The first prerelease identifier.
- **prereleaseIdentifiers** (PrereleaseIdentifier[]) - Description: Additional prerelease identifiers.
```

--------------------------------

### Create SemVersion with new build metadata identifiers (IEnumerable<MetadataIdentifier>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Use this WithMetadata overload to create a new SemVersion instance with updated build metadata when you have a collection of MetadataIdentifier objects. It provides a convenient way to replace all existing metadata.

```csharp
public SemVersion WithMetadata(IEnumerable<MetadataIdentifier> metadataIdentifiers)
```

--------------------------------

### UnbrokenSemVersionRange End Property

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Gets the end (maximum) version of the range. This can be null for ranges with no upper bound.

```csharp
public SemVersion End { get; }
```

--------------------------------

### Compare Precedence of SemVersions

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Compares this SemVersion instance to another to determine their precedence order. Versions differing only by build metadata are considered equal in precedence.

```csharp
public int ComparePrecedenceTo(SemVersion other)
```

--------------------------------

### NumericValue Property

Source: https://semver-nuget.org/v3.0.x/Semver.PrereleaseIdentifier.html

Gets the numeric value of the prerelease identifier if it is a numeric identifier; otherwise, returns null.

```APIDOC
## NumericValue Property

### Description
Gets the numeric value of the prerelease identifier if it is a numeric identifier, otherwise null.

### Declaration
```
public Nullable<BigInteger> NumericValue { get; }
```

### Property Value
- **System.Nullable<System.Numerics.BigInteger>** - The numeric value of the prerelease identifier if it is a numeric identifier, otherwise null.

### Remarks
The numeric value of a prerelease identifier will never be negative.
```

--------------------------------

### WithPrerelease(IEnumerable<String>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with different prerelease identifiers. This overload accepts a collection of strings representing the prerelease identifiers.

```APIDOC
## WithPrerelease(IEnumerable<String>)

### Description
Creates a copy of the current instance with different prerelease identifiers.

### Method
SemVersion

### Parameters
#### Path Parameters
- **prereleaseIdentifiers** (String[]) - Required - The identifiers to replace the prerelease identifiers.

### Returns
Type | Description
---|---
SemVersion | The new version with the different prerelease identifiers.

### Exceptions
- **System.ArgumentNullException**: `prereleaseIdentifiers` is null or one of the prerelease identifiers is null.
- **System.ArgumentException**: A prerelease identifier is empty or contains invalid characters (i.e. characters that are not ASCII alphanumerics or hyphens) or has leading zeros for a numeric identifier.
```

--------------------------------

### Value Property

Source: https://semver-nuget.org/v3.0.x/Semver.MetadataIdentifier.html

Gets the string value of the metadata identifier. This can be null if the identifier is the default struct value.

```APIDOC
## Value Property

### Description
Gets the string value of the metadata identifier. This can be null if the identifier is the default struct value.

### Property Value
- **System.String**: The string value of this metadata identifier or null if this is a default MetadataIdentifier.
```

--------------------------------

### InclusiveOfEnd(SemVersion, SemVersion, Boolean)

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Construct a range containing all versions between the given versions including the end but not the start.

```APIDOC
## InclusiveOfEnd(SemVersion, SemVersion, Boolean)

### Description
Construct a range containing all versions between the given versions including the end but not the start.

### Method
`public static UnbrokenSemVersionRange InclusiveOfEnd(SemVersion start, SemVersion end, bool includeAllPrerelease = false)`

### Parameters
#### Path Parameters
- **start** (SemVersion) - Required - The range will contain only versions greater than this.
- **end** (SemVersion) - Required - The range will contain only versions less than or equal to this.
- **includeAllPrerelease** (System.Boolean) - Optional - Include all prerelease versions in the range rather than just those matching the given versions if they are prerelease.

### Returns
#### Success Response
- **UnbrokenSemVersionRange** (UnbrokenSemVersionRange) - A range containing versions between the given versions including the end but not the start.
```

--------------------------------

### With(Nullable<BigInteger>, Nullable<BigInteger>, Nullable<BigInteger>, IEnumerable<PrereleaseIdentifier>, IEnumerable<MetadataIdentifier>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with specified properties changed.

```APIDOC
## With(Nullable<BigInteger>, Nullable<BigInteger>, Nullable<BigInteger>, IEnumerable<PrereleaseIdentifier>, IEnumerable<MetadataIdentifier>)

### Description
Creates a copy of the current instance with multiple changed properties. If changing only one property use one of the more specific `WithX()` methods.

### Declaration
```csharp
public SemVersion With(Nullable<BigInteger> major = null, Nullable<BigInteger> minor = null, Nullable<BigInteger> patch = null, IEnumerable<PrereleaseIdentifier> prerelease = null, IEnumerable<MetadataIdentifier> metadata = null)
```

### Parameters
- **major** (System.Nullable<System.Numerics.BigInteger>) - The value to replace the major version number or null to leave it unchanged.
- **minor** (System.Nullable<System.Numerics.BigInteger>) - The value to replace the minor version number or null to leave it unchanged.
- **patch** (System.Nullable<System.Numerics.BigInteger>) - The value to replace the patch version number or null to leave it unchanged.
- **prerelease** (System.Collections.Generic.IEnumerable<PrereleaseIdentifier>) - The value to replace the prerelease identifiers or null to leave it unchanged.
- **metadata** (System.Collections.Generic.IEnumerable<MetadataIdentifier>) - The value to replace the build metadata identifiers or null to leave it unchanged.

### Returns
- **SemVersion**: The new version with changed properties.

### Remarks
The With(Nullable<BigInteger>, Nullable<BigInteger>, Nullable<BigInteger>, IEnumerable<PrereleaseIdentifier>, IEnumerable<MetadataIdentifier>) method is intended to be called using named argument syntax, passing only those fields to be changed.

### Examples
To change the minor and patch versions:
```csharp
var modifiedVersion = version.With(minor: 2, patch: 4);
```
```

--------------------------------

### Value Property

Source: https://semver-nuget.org/v3.0.x/Semver.PrereleaseIdentifier.html

Gets the string representation of the prerelease identifier, preserving leading zeros for invalid numeric identifiers.

```APIDOC
## Value Property

### Description
Gets the string value of the prerelease identifier even if it is a numeric identifier.

### Declaration
```
public string Value { get; }
```

### Property Value
- **System.String** - The string value of this prerelease identifier even if it is a numeric identifier or null if this is a default PrereleaseIdentifier.

### Remarks
Invalid numeric prerelease identifiers with leading zeros will have a string value including the leading zeros. This can be used to distinguish invalid numeric identifiers with different numbers of leading zeros.
```

--------------------------------

### UnbrokenSemVersionRange Empty Property

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Represents an empty range that contains no versions. This is typically defined as a range where the start is greater than the end.

```csharp
public static UnbrokenSemVersionRange Empty { get; }
```

--------------------------------

### Metadata Identifiers Property

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Gets the build metadata identifiers as a read-only list. Metadata identifiers are dot-separated and follow a '+'.

```csharp
public IReadOnlyList<MetadataIdentifier> MetadataIdentifiers { get; }
```

--------------------------------

### Create SemVersion with parsed build metadata from a string

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Use the WithMetadataParsedFrom method to create a new SemVersion instance by parsing a single string that represents the build metadata. This is useful for setting metadata from a formatted string.

```csharp
public SemVersion WithMetadataParsedFrom(string metadata)
```

--------------------------------

### WithPrerelease(String, String[])

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with different prerelease identifiers. This overload takes the first identifier and a variable number of subsequent identifiers.

```APIDOC
## WithPrerelease(String, String[])

### Description
Creates a copy of the current instance with different prerelease identifiers.

### Method
SemVersion

### Parameters
#### Path Parameters
- **prereleaseIdentifier** (String) - Required - The first identifier to replace the existing prerelease identifiers.
- **prereleaseIdentifiers** (String[]) - Required - The rest of the identifiers to replace the existing prerelease identifiers.

### Returns
Type | Description
---|---
SemVersion | The new version with the different prerelease identifiers.

### Exceptions
- **System.ArgumentNullException**: `prereleaseIdentifier` or `prereleaseIdentifiers` is null or one of the prerelease identifiers is null.
- **System.ArgumentException**: A prerelease identifier is empty or contains invalid characters (i.e. characters that are not ASCII alphanumerics or hyphens) or has leading zeros for a numeric identifier.
```

--------------------------------

### Create SemVersion with different prerelease identifiers

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Use WithPrerelease to create a new SemVersion instance with specified prerelease identifiers. This method allows setting multiple prerelease identifiers.

```csharp
public SemVersion WithPrerelease(PrereleaseIdentifier prereleaseIdentifier, params PrereleaseIdentifier[] prereleaseIdentifiers)
```

--------------------------------

### Get Numeric Value of PrereleaseIdentifier

Source: https://semver-nuget.org/v3.0.x/Semver.PrereleaseIdentifier.html

Retrieves the numeric value of the identifier if it is numeric; otherwise, returns null. The numeric value will never be negative.

```csharp
public Nullable<BigInteger> NumericValue { get; }
```

--------------------------------

### Loose Option

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRangeOptions.html

Accepts any version string format currently supported. The set of accepted formats may change in future versions.

```csharp
public const SemVersionRangeOptions Loose
```

--------------------------------

### SemVersionRange.Create Method

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Constructs a SemVersionRange by joining multiple UnbrokenSemVersionRanges. The resulting ranges are simplified and sorted.

```csharp
public static SemVersionRange Create(params UnbrokenSemVersionRange[] ranges)
```

--------------------------------

### Metadata Property

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Retrieves the build metadata as a string. Metadata is appended after a '+' and does not affect precedence but influences sort order.

```csharp
public string Metadata { get; }
```

--------------------------------

### Create SemVersion with new build metadata identifiers (MetadataIdentifier)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Use the WithMetadata overload that accepts MetadataIdentifier objects to create a new SemVersion instance with updated build metadata. This method is useful when you have pre-parsed metadata identifiers.

```csharp
public SemVersion WithMetadata(MetadataIdentifier metadataIdentifier, params MetadataIdentifier[] metadataIdentifiers)
```

--------------------------------

### Construct SemVersion with String Collections

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Constructs a new SemVersion instance using string collections for prerelease and metadata identifiers. This constructor validates that prerelease identifiers are alphanumeric or hyphens, do not have leading zeros for numeric parts, and that metadata identifiers are also valid. Null identifiers are not permitted.

```csharp
public SemVersion(BigInteger major, BigInteger minor = null, BigInteger patch = null, IEnumerable<string> prerelease = null, IEnumerable<string> metadata = null)
```

--------------------------------

### Get Hash Code for SemVersion

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Obtain a hash code for a SemVersion instance. This is useful for using SemVersion objects in hash-based collections. Note that versions with the same precedence may not have the same hash code.

```csharp
public override int GetHashCode()

```

--------------------------------

### Construct SemVersion with Major, Minor, and Patch

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Constructs a new SemVersion instance with major, minor, and patch version numbers. None of these version components can be negative.

```csharp
public SemVersion(BigInteger major, BigInteger minor, BigInteger patch)
```

--------------------------------

### Convert SemVersion to System.Version

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Converts a SemVersion object to a System.Version object. Note that prerelease versions and build metadata are not representable in System.Version and will cause an exception.

```csharp
public Version ToVersion()
```

--------------------------------

### Sort Order Comparer Declaration

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Get a comparer for SemVersion objects that orders them by sort order. This comparer implements both IEqualityComparer and IComparer, making it suitable for use in collections and sorting algorithms.

```csharp
public static ISemVersionComparer SortOrderComparer { get; }
```

--------------------------------

### GetHashCode()

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Gets a hash code for this SemVersion instance, suitable for use in hashing algorithms and data structures like a hash table. Note that two versions that are equal may not have the same hash code.

```APIDOC
## GetHashCode()

### Description
Gets a hash code for this SemVersion instance, suitable for use in hashing algorithms and data structures like a hash table. Note that two versions that are equal may not have the same hash code.

### Method
```csharp
public override int GetHashCode()
```

### Returns
#### Success Response
- **System.Int32** - A hash code for this instance.
```

--------------------------------

### Bitwise Combination of SemVersionRangeOptions

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRangeOptions.html

Demonstrates how to combine multiple SemVersionRangeOptions using the bitwise OR operator.

```csharp
SemVersionRangeOptions.OptionalPatch | SemVersionRangeOptions.AllowV
```

--------------------------------

### AllowUpperV Style

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionStyles.html

Allows a leading uppercase 'V' prefix in version strings.

```csharp
public const SemVersionStyles AllowUpperV
```

--------------------------------

### CompareTo(Object)

Source: https://semver-nuget.org/v3.0.x/Semver.PrereleaseIdentifier.html

Compares this prerelease identifier to another object to determine their precedence order. It returns -1 if this instance precedes the object, 0 if they are equal, and 1 if this instance follows the object or the object is null.

```APIDOC
## CompareTo(Object)

### Description
Compares this identifier to an System.Object and indicates whether this instance precedes, follows, or is equal to the object in precedence order.

### Method
```
public int CompareTo(object value)
```

### Parameters
#### Path Parameters
- **value** (System.Object) - Description: 

### Returns
- **System.Int32** - An integer that indicates whether this instance precedes, follows, or is equal to `value` in precedence order. Value: -1 (This instance precedes `value`), 0 (This instance is equal to `value`), 1 (This instance follows `value` or `value` is null).

### Remarks
Numeric identifiers have lower precedence than alphanumeric identifiers. Numeric identifiers are compared numerically. Numeric identifiers with leading zeros are considered equal (e.g. '`15`' is equal to '`015`'). Alphanumeric identifiers are compared lexically in ASCII sort order. Invalid alphanumeric identifiers are compared via an ordinal string comparison.

### Exceptions
- **System.ArgumentException** - `value` is not a PrereleaseIdentifier.
```

--------------------------------

### WithPrerelease(IEnumerable<PrereleaseIdentifier>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with different prerelease identifiers. This overload accepts a collection of PrereleaseIdentifier objects.

```APIDOC
## WithPrerelease(IEnumerable<PrereleaseIdentifier>)

### Description
Creates a copy of the current instance with different prerelease identifiers.

### Method
SemVersion

### Parameters
#### Path Parameters
- **prereleaseIdentifiers** (PrereleaseIdentifier[]) - Required - The rest of the identifiers to replace the existing prerelease identifiers.

### Returns
Type | Description
---|---
SemVersion | The new version with the different prerelease identifiers.

### Exceptions
- **System.ArgumentNullException**: `prereleaseIdentifiers` is null.
- **System.ArgumentException**: A prerelease identifier has the default value.
```

--------------------------------

### AllowLeadingZeros Option

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRangeOptions.html

Enables parsing of version numbers with leading zeros on major, minor, patch, and prerelease components. Leading zeros are removed from the resulting version number.

```csharp
public const SemVersionRangeOptions AllowLeadingZeros
```

--------------------------------

### SemVersionRange.AtMost Method

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Constructs a range that includes versions equal to or less than the specified version. Optionally includes all prerelease versions.

```csharp
public static SemVersionRange AtMost(SemVersion version, bool includeAllPrerelease = false)
```

--------------------------------

### ToVersion()

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Converts the current SemVersion object to a System.Version object.

```APIDOC
## ToVersion()

### Description
Converts this semantic version to a System.Version.

### Declaration
```csharp
public Version ToVersion()
```

### Returns
- **System.Version**: The equivalent System.Version.

### Remarks
A semantic version of the form _major_._minor_._patch_ is converted to a System.Version of the form _major_._minor_._build_ where the build number is the patch version of the semantic version. Prerelease versions and build metadata are not representable in a System.Version. This method throws an System.InvalidOperationException if the semantic version is a prerelease version or has build metadata.

### Exceptions
- **System.InvalidOperationException**: The semantic version is a prerelease version or has build metadata or has a major, minor, or patch version number greater than System.Int32.MaxValue.
```

--------------------------------

### WithPatch

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with a different patch version number.

```APIDOC
## WithPatch(BigInteger)

### Description
Creates a copy of the current instance with a different patch version number.

### Method Signature
```csharp
public SemVersion WithPatch(BigInteger patch)
```

### Parameters
#### Path Parameters
- **patch** (System.Numerics.BigInteger) - Description: The value to replace the patch version number.

### Returns
- **SemVersion** - The new version with the different patch version number.

### Exceptions
- **System.ArgumentOutOfRangeException**: `patch` is negative.
```

--------------------------------

### WithParsedFrom

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with multiple changed properties, parsing prerelease and metadata from strings.

```APIDOC
## WithParsedFrom(Nullable<BigInteger>, Nullable<BigInteger>, Nullable<BigInteger>, String, String, Boolean)

### Description
Creates a copy of the current instance with multiple changed properties. Parses prerelease and metadata identifiers from dot separated strings. Use With(Nullable<BigInteger>, Nullable<BigInteger>, Nullable<BigInteger>, IEnumerable<PrereleaseIdentifier>, IEnumerable<MetadataIdentifier>) instead if parsing is not needed. If changing only one property use one of the more specific `WithX()` methods.

### Method Signature
```csharp
public SemVersion WithParsedFrom(Nullable<BigInteger> major = null, Nullable<BigInteger> minor = null, Nullable<BigInteger> patch = null, string prerelease = null, string metadata = null, bool allowLeadingZeros = false)
```

### Parameters
#### Path Parameters
- **major** (System.Nullable<System.Numerics.BigInteger>) - Optional - The value to replace the major version number or null to leave it unchanged.
- **minor** (System.Nullable<System.Numerics.BigInteger>) - Optional - The value to replace the minor version number or null to leave it unchanged.
- **patch** (System.Nullable<System.Numerics.BigInteger>) - Optional - The value to replace the patch version number or null to leave it unchanged.
- **prerelease** (System.String) - Optional - The value to replace the prerelease identifiers or null to leave it unchanged.
- **metadata** (System.String) - Optional - The value to replace the build metadata identifiers or null to leave it unchanged.
- **allowLeadingZeros** (System.Boolean) - Optional - Allow leading zeros in numeric prerelease identifiers. Leading zeros will be removed.

### Returns
- **SemVersion** - The new version with changed properties.

### Remarks
The WithParsedFrom(Nullable<BigInteger>, Nullable<BigInteger>, Nullable<BigInteger>, String, String, Boolean) method is intended to be called using named argument syntax, passing only those fields to be changed.

### Request Example
```csharp
var modifiedVersion = version.WithParsedFrom(patch: 4, prerelease: "alpha.5");
```

### Exceptions
- **System.ArgumentOutOfRangeException**: The `major`, `minor`, or `patch` version number is negative.
- **System.ArgumentException**: A prerelease identifier is empty or contains invalid characters (i.e. characters that are not ASCII alphanumerics or hyphens) or has leading zeros for a numeric identifier when `allowLeadingZeros` is false. Or, a metadata identifier is empty or contains invalid characters (i.e. characters that are not ASCII alphanumerics or hyphens).
```

--------------------------------

### AllowV Option

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRangeOptions.html

Enables parsing of version numbers with a leading 'v' or 'V' prefix.

```csharp
public const SemVersionRangeOptions AllowV
```

--------------------------------

### SemVersion.WithMetadata

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a new SemVersion instance with updated build metadata identifiers. Multiple overloads are provided to accommodate different input formats for metadata.

```APIDOC
## SemVersion.WithMetadata(MetadataIdentifier metadataIdentifier, params MetadataIdentifier[] metadataIdentifiers)

### Description
Creates a copy of the current instance with different build metadata identifiers.

### Method
SemVersion.WithMetadata

### Parameters
#### Path Parameters
- **metadataIdentifier** (MetadataIdentifier) - Required - The first identifier to replace the existing build metadata identifiers.
- **metadataIdentifiers** (MetadataIdentifier[]) - Required - The rest of the identifiers to replace the existing build metadata identifiers.

### Returns
- **SemVersion** - The new version with the different build metadata identifiers.

### Exceptions
- **System.ArgumentNullException**: `metadataIdentifiers` is null.
- **System.ArgumentException**: A prerelease or metadata identifier has the default value.
```

```APIDOC
## SemVersion.WithMetadata(IEnumerable<MetadataIdentifier> metadataIdentifiers)

### Description
Creates a copy of the current instance with different build metadata identifiers.

### Method
SemVersion.WithMetadata

### Parameters
#### Path Parameters
- **metadataIdentifiers** (IEnumerable<MetadataIdentifier>) - Required - The identifiers to replace the build metadata identifiers.

### Returns
- **SemVersion** - The new version with the different build metadata identifiers.

### Exceptions
- **System.ArgumentNullException**: `metadataIdentifiers` is null.
- **System.ArgumentException**: A prerelease or metadata identifier has the default value.
```

```APIDOC
## SemVersion.WithMetadata(IEnumerable<String> metadataIdentifiers)

### Description
Creates a copy of the current instance with different build metadata identifiers.

### Method
SemVersion.WithMetadata

### Parameters
#### Path Parameters
- **metadataIdentifiers** (IEnumerable<String>) - Required - The identifiers to replace the build metadata identifiers.

### Returns
- **SemVersion** - The new version with the different build metadata identifiers.

### Exceptions
- **System.ArgumentNullException**: `metadataIdentifiers` is null or one of the metadata identifiers is null.
- **System.ArgumentException**: A metadata identifier is empty or contains invalid characters (i.e. characters that are not ASCII alphanumerics or hyphens).
```

```APIDOC
## SemVersion.WithMetadata(String metadataIdentifier, params String[] metadataIdentifiers)

### Description
Creates a copy of the current instance with different build metadata identifiers.

### Method
SemVersion.WithMetadata

### Parameters
#### Path Parameters
- **metadataIdentifier** (String) - Required - The first identifier to replace the existing build metadata identifiers.
- **metadataIdentifiers** (String[]) - Required - The rest of the build metadata identifiers to replace the existing build metadata identifiers.

### Returns
- **SemVersion** - The new version with the different build metadata identifiers.

### Exceptions
- **System.ArgumentNullException**: `metadataIdentifier` or `metadataIdentifiers` is null or one of the metadata identifiers is null.
- **System.ArgumentException**: A metadata identifier is empty or contains invalid characters (i.e. characters that are not ASCII alphanumerics or hyphens).
```

--------------------------------

### Inclusive(SemVersion, SemVersion, Boolean)

Source: https://semver-nuget.org/v3.0.x/Semver.UnbrokenSemVersionRange.html

Construct a range containing all versions between the given versions including those versions.

```APIDOC
## Inclusive(SemVersion, SemVersion, Boolean)

### Description
Construct a range containing all versions between the given versions including those versions.

### Method
`public static UnbrokenSemVersionRange Inclusive(SemVersion start, SemVersion end, bool includeAllPrerelease = false)`

### Parameters
#### Path Parameters
- **start** (SemVersion) - Required - The range will contain only versions greater than or equal to this.
- **end** (SemVersion) - Required - The range will contain only versions less than or equal to this.
- **includeAllPrerelease** (System.Boolean) - Optional - Include all prerelease versions in the range rather than just those matching the given versions if they are prerelease.

### Returns
#### Success Response
- **UnbrokenSemVersionRange** (UnbrokenSemVersionRange) - A range containing versions between the given versions including those versions.
```

--------------------------------

### Compare Sort Order of Two SemVersions

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Compares two SemVersion instances to determine their sort order. Sort order is more specific than precedence, considering build metadata.

```csharp
public static int CompareSortOrder(SemVersion left, SemVersion right)
```

--------------------------------

### WithPrereleaseParsedFrom(String, Boolean)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Creates a copy of the current SemVersion instance with a different prerelease portion, parsed from a string. Allows control over whether leading zeros are permitted in numeric identifiers.

```APIDOC
## WithPrereleaseParsedFrom(String, Boolean)

### Description
Creates a copy of the current instance with a different prerelease portion.

### Method
SemVersion

### Parameters
#### Path Parameters
- **prerelease** (String) - Required - The value to replace the prerelease portion.
- **allowLeadingZeros** (Boolean) - Optional - Whether to allow leading zeros in the prerelease identifiers. If true, leading zeros will be allowed on numeric identifiers but will be removed. Defaults to false.

### Returns
Type | Description
---|---
SemVersion | The new version with the different prerelease identifiers.

### Remarks
Because a valid numeric identifier does not have leading zeros, this constructor will never create a PrereleaseIdentifier with leading zeros even if `allowLeadingZeros` is true. Any leading zeros will be removed.

### Exceptions
- **System.ArgumentNullException**: `prerelease` is null.
- **System.ArgumentException**: A prerelease identifier is empty or contains invalid characters (i.e. characters that are not ASCII alphanumerics or hyphens) or has leading zeros for a numeric identifier when `allowLeadingZeros` is false.
```

--------------------------------

### SemVersionRange.AllRelease Property

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Represents a range that includes all release versions but excludes prerelease versions.

```csharp
public static SemVersionRange AllRelease { get; }
```

--------------------------------

### Create(IEnumerable<UnbrokenSemVersionRange>)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersionRange.html

Constructs a SemVersionRange by joining multiple UnbrokenSemVersionRanges. The resulting range encompasses all versions present in any of the provided unbroken ranges. The ranges are simplified and sorted during construction.

```APIDOC
## Create(IEnumerable<UnbrokenSemVersionRange>)

### Description
Constructs a SemVersionRange by joining multiple UnbrokenSemVersionRanges. The resulting range encompasses all versions present in any of the provided unbroken ranges. The ranges are simplified and sorted during construction.

### Method
static

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **SemVersionRange** (SemVersionRange) - A range that joins the given UnbrokenSemVersionRanges. It will contain all versions contained by any of the given unbroken ranges.

#### Response Example
None

### Remarks
The unbroken ranges are simplified and sorted. So, the resulting SemVersionRange may not contain the same number of UnbrokenSemVersionRanges in the same order as passed to this method.
```

--------------------------------

### TryParse(String, SemVersionStyles, out SemVersion, Int32)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Converts the string representation of a semantic version to its SemVersion equivalent with specified styles.

```APIDOC
## TryParse(String, SemVersionStyles, out SemVersion, Int32)

### Description
Converts the string representation of a semantic version to its SemVersion equivalent. The return value indicates whether the conversion succeeded.

### Declaration
```csharp
public static bool TryParse(string version, SemVersionStyles style, out SemVersion semver, int maxLength = 1024)
```

### Parameters
- **version** (System.String) - The version string.
- **style** (SemVersionStyles) - A bitwise combination of enumeration values that indicates the style elements that can be present in `version`. The preferred value to use is Strict.
- **semver** (SemVersion) - When this method returns, contains a SemVersion instance equivalent to the version string passed in, if the version string was valid, or null if the version string was invalid.
- **maxLength** (System.Int32) - The maximum length of `version` that should be parsed. This prevents attacks using very long version strings.

### Returns
- **System.Boolean**: false when an invalid version string is passed, otherwise true.

### Exceptions
- **System.ArgumentException**: `style` is not a valid SemVersionStyles value.
```

--------------------------------

### Parse and Use SemVersion Ranges

Source: https://semver-nuget.org/v3.0.x/index.html

Parses semantic version ranges and checks if a version satisfies them, including prerelease versions.

```csharp
var range = SemVersionRange.Parse("^1.0.0");
var prereleaseRange = SemVersionRange.ParseNpm("^1.0.0", includeAllPrerelease: true);
Console.WriteLine($"Range: {range}");
Console.WriteLine($"Prerelease range: {prereleaseRange}");
Console.WriteLine($"Range includes version {version}: {range.Contains(version)}");
Console.WriteLine($"Prerelease range includes version {version}: {prereleaseRange.Contains(version)}");

// Alternative: another way to call SemVersionRange.Contains(version)
version.Satisfies(range);

// Alternative: slower because it parses the range on every call
version.SatisfiesNpm("^1.0.0", includeAllPrerelease: true)

```

--------------------------------

### Construct SemVersion with Major and Minor

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Constructs a new SemVersion instance with major and minor version numbers. Neither major nor minor can be negative.

```csharp
public SemVersion(BigInteger major, BigInteger minor)
```

--------------------------------

### FromVersion(Version)

Source: https://semver-nuget.org/v3.0.x/Semver.SemVersion.html

Converts a System.Version into its equivalent SemVersion. This method handles the conversion of major, minor, and patch numbers, assuming a patch of zero if not specified in System.Version. It throws an exception if the System.Version has a revision number greater than zero.

```APIDOC
## FromVersion(Version)

### Description
Converts a System.Version into its equivalent SemVersion. This method handles the conversion of major, minor, and patch numbers, assuming a patch of zero if not specified in System.Version. It throws an exception if the System.Version has a revision number greater than zero.

### Method
```csharp
public static SemVersion FromVersion(Version version)
```

### Parameters
#### Parameters
- **version** (System.Version) - The version to be converted to a semantic version.

### Returns
#### Success Response
- **SemVersion** - The equivalent semantic version.

### Exceptions
- **System.ArgumentNullException**: `version` is null.
- **System.ArgumentException**: `version` has a revision number greater than zero.
```
Tokens:
Raw