The semantic version parser.

Underlying builder API for executing commands.

Result of running a command.

Holds a reference to a path providing helper methods.

A progress bar instance created via $.progress(...).

Builder API for downloading files.

Result of making a request.

Helpers for dealing with a Releases.md file.

Default $ instance where commands may be executed.

Default $ instance where commands may be executed.

Default $ instance where commands may be executed.

Builds a new $ which will use the state of the provided builders as the default.

Pass in a comparison string, and it'll call the corresponding comparison function. "===" and "!==" do simple string comparison, but are included for completeness. Throws if an invalid comparison string is provided.

Returns 0 if v1 == v2, or 1 if v1 is greater, or -1 if v2 is greater. Sorts in ascending order if passed to Array.sort(),

The same as compare but considers build when two versions are equal. Sorts in ascending order if passed to Array.sort().

Returns difference between two versions by the release type (major, premajor, minor, preminor, patch, prepatch, or prerelease), or null if the versions are the same.

This is true if they're logically equivalent, even if they're not the exact same string.

Greater than comparison

Greater than or equal comparison

Returns true if version is greater than all the versions possible in the range.

Returns the version incremented by the release type (major, minor, patch, or prerelease), or null if it's not valid.

Returns true if the two supplied ranges or comparators intersect.

Less than comparison

Less than or equal comparison

Returns true if version is less than all the versions possible in the range.

Returns the major version number.

Returns the highest version in the list that satisfies the range, or null if none of them do.

Returns the minor version number.

Returns the lowest version in the list that satisfies the range, or null if none of them do.

Returns the lowest version that can possibly match the given range.

This is true if they're not logically equivalent, even if they're the exact same string.

Returns true if the version is outside the bounds of the range in either the high or low direction. The hilo argument must be either the string '>' or '<'. (This is the function called by gtr and ltr.)

Attempt to parse a string as a semantic version, returning either a SemVer object or null.

Returns the patch version number.

Returns an array of prerelease components, or null if none exist.

Returns 0 if v1 == v2, or -1 if v1 is greater, or 1 if v2 is greater. Sorts in descending order if passed to Array.sort(),

Returns true if the version satisfies the range.

Returns the parsed version, or null if it's not valid.

Returns the valid range or null if it's not valid.

Change that alters the current working directory.

Context of the currently executing command.

Used to write to stdout or stderr.

Options for showing confirming a yes or no question.

Tells the shell to continue executing.

Options for creating a custom $.

Tells the shell it should exit immediately with the provided exit code.

Single options within a multi-select option.

Options for showing a selection that has multiple possible values.

Options for showing progress.

Options for showing an input where the user enters a value.

Options for using $.retry({ ... })

Options for showing a selection that only has one result.

Change that sets an environment variable (ex. export ENV_VAR=VALUE)

Change that sets a shell variable (ex. ENV_VAR=VALUE)

Type of $ instances.

Handler for executing a command.

Used to read from stdin.

Change that alters the environment.

Result of executing a custom command.

The semantic version parser.