Module verl

Function Index

compare/2 Compare two version returing whether first argument is greater, equal, or less than than second argument.
compile_requirement/1 Compiles a version requirement as returned by parse_requirement for faster matches.
is_match/2 Returns true if the dependency is in range of the requirement, otherwise false.
is_match/3 Exactly like is_match/2 but takes an options argument.
parse/1 Parses a semantic version returing a version_t() or {error, invalid_version}.
parse_requirement/1 Parses a semantic version requirement, returns a requirement_t().

Function Details

compare/2

compare(Version1::version(), Version2::version()) -> gt | eq | lt | {error, invalid_version}

Compare two version returing whether first argument is greater, equal, or less than than second argument.

compile_requirement/1

compile_requirement(Req::map()) -> {ok, map()} | error

Compiles a version requirement as returned by parse_requirement for faster matches.

is_match/2

is_match(Version::any(), Requirement::any()) -> {ok, boolean()} | {error, binary()}

Returns true if the dependency is in range of the requirement, otherwise false.

is_match/3

is_match(Version, Requirement, Opts) -> any()

Exactly like is_match/2 but takes an options argument.

parse/1

parse(Str::version()) -> {ok, version_t()} | {error, invalid_version}

Parses a semantic version returing a version_t() or {error, invalid_version}

parse_requirement/1

parse_requirement(Str::requirement()) -> {ok, requirement_t()} | {error, invalid_requirement}

Parses a semantic version requirement, returns a requirement_t()


Generated by EDoc