satisfied_version 0.0.2 satisfied_version: ^0.0.2 copied to clipboard
Check whether the version is satisfied with provided String, List, or Map of versions or not.
Satisfied Version #
Check whether the version is satisfied with provided String, List, or Map of versions or not.
Usage #
String: Compare 2 version with conditions #
SatisfiedVersion.isSatisfied('1.0.0', '>=1.0.0') // => true
SatisfiedVersion.isSatisfied('1.0.0', '<=1.0.0') // => true
SatisfiedVersion.isSatisfied('1.0.0', '>1.0.0') // => false
SatisfiedVersion.isSatisfied('1.0.1', '>1.0.0') // => true
SatisfiedVersion.isSatisfied('1.0.0', '<1.0.0') // => false
SatisfiedVersion.isSatisfied('1.0.0', '=1.0.0') // => true
SatisfiedVersion.isSatisfied('1.0.0', '==1.0.0') // => true
// Default is return `appVersion == version`
List: Return true
if there is any satisfied version in sources #
const versions = ['<1.0.0', '>=1.0.2'];
print(SatisfiedVersion.list('1.0.0', versions)); // => false
print(SatisfiedVersion.list('1.0.3', versions)); // => true
print(SatisfiedVersion.list('0.0.9', versions)); // => true
You can also compare the version within the range:
// You can input a shuffled list of values, the plugin will sort it for you.
// But I recommend you to sort it yourself to make it easier to maintain.
const versionsWithin= ['>1.0.0', '<1.5.0', '1.6.0', '>=2.0.0', '<2.0.2'];
print(SatisfiedVersion.list('1.0.0', versionsWithin); // => false
print(SatisfiedVersion.list('1.1.0', versionsWithin); // => true
print(SatisfiedVersion.list('1.5.1', versionsWithin); // => false
print(SatisfiedVersion.list('1.6.0', versionsWithin); // => true
print(SatisfiedVersion.list('2.0.1', versionsWithin); // => true
print(SatisfiedVersion.list('2.0.2', versionsWithin); // => false
Map: Return value of the satisfied key. Default is false
#
preferTrue
=true
: Returntrue
if it has at least 1 true condition.preferTrue
=false
: Returnfalse
if it has at least 1 false condition. Default.
const versions = {'<1.0.0' : true, '>=1.0.2' : false};
print(SatisfiedVersion.map('1.0.0', versions)); // => false
print(SatisfiedVersion.map('1.0.3', versions)); // => false
print(SatisfiedVersion.map('0.0.9', versions)); // => true
Extension: There is also a extension for String that help you easier to use this plugin #
final result = '1.0.0'.isSatisfiedVersion('<=1.0.0'); // => true
final result = '1.0.0'.isSatisfiedVersion(['<=1.0.0']); // => true
final result = '1.0.0'.isSatisfiedVersion(['<=1.0.0' : false]); // => false
Additional Parameters #
-
For all:
defaultCondition
is the default condition if the compared version is provided without condition. Default value isSatisfiedCondition.equal
.
-
For specific
Map
:defaultValue
is the default result forMap
whenappVersion
is not in any range.preferTrue
is the preferred value when there are multiple results inMap
.