hoar

var Hoar  = require( 'hoar' );

/*
 * Compare 2 versions with a condition.
 * A version could be also specified through an Array like: [ 1, 0, 0 ].
 * Following conditions are supported: '=', '<', '>', '<=', '>=', '<>'
 *
 * NOTE: it is compliant with all precedence rules specified in the
 * "Semver 2.0" specification.
 */
Hoar#compare( String version1 | Array semver1, String version2 | Array semver2, String condition ) : Boolean
 
/*
 * Some #compare shortcuts for '=', '<', '>', '<=', '>=', '<>'
 */
Hoar#eq( String v1 | Array semver1, String v2 | Array semver2 ) : Boolean
 
Hoar#lt( String v1 | Array semver1, String v2 | Array semver2 ) : Boolean
 
Hoar#gt( String v1 | Array semver1, String v2 | Array semver2 ) : Boolean
 
Hoar#lte( String v1 | Array semver1, String v2 | Array semver2 ) : Boolean
 
Hoar#gte( String v1 | Array semver1, String v2 | Array semver2 ) : Boolean
 
Hoar#neq( String v1 | Array semver1, String v2 | Array semver2 ) : Boolean
 
/*
 * Check if a version, or a list of versions, is/are between a range.
 * The range is specified as a 2-element Array; elements respectively
 * represent the lower and the higher bounds for a version range.
 *
 * NOTE: for default, strict ('<','>') operators are used for range
 * comparisons, optionally you can use the 'nostrict' option:
 *
 * - 0, for range[ 0 ] <  version <  range[ 1 ]
 * - 1, for range[ 0 ] <= version <  range[ 1 ]
 * - 2, for range[ 0 ] <  version <= range[ 1 ]
 * - 3, for range[ 0 ] <= version <= range[ 1 ]
 */
Hoar#range( String version | Array versions, Array range [, Number nostrict [, Boolean debug ] ] ) : Boolean
 
/*
 * Parse a version string, optionally specifying an array for result,
 * and/or a filter function to be applied to every identifier.
 * It splits the string into a nested Array containing all elements
 * parsed.
 *
 * NOTE: For default filter function gets the current string parsed and
 * removes all non alpha-numeric chars, then convert a string representation
 * of a number to a Number.
 *
 * Example:
 *
 * A call to parse produces a list of 1 or 2 arrays, the first containing
 * the normal version identifiers, the second containing pre-release
 * identifiers, if any exist ( sub-string after '-' ).
 * List of identifiers about build meta data ( sub-string after '+' ),
 * will be pushed to the 'normal version' or 'pre-release version' array.
 *
 * parse( "1.0.1-pre.1.x+build001" );
 *
 * [ [ 1, 0, 1 ], [ 'pre', 1,'x', [ 'build001' ] ] ]
 *
 */
Hoar#parse( String version [, Array result [, Function filter ] ] ) : Array
 
/*
 * printing infos about a #parse result: Hoar.print( Hoar.parse( '..' ) );
 */
Hoar#print( Array semver ) : undefined