Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lamnhan066/satisfied_version
Check current version is sastisfied with version, list of versions and map of versions
https://github.com/lamnhan066/satisfied_version
dart flutter package
Last synced: 7 days ago
JSON representation
Check current version is sastisfied with version, list of versions and map of versions
- Host: GitHub
- URL: https://github.com/lamnhan066/satisfied_version
- Owner: lamnhan066
- License: mit
- Created: 2022-09-18T03:35:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-07T03:41:39.000Z (about 1 year ago)
- Last Synced: 2023-10-08T04:06:06.334Z (about 1 year ago)
- Topics: dart, flutter, package
- Language: Dart
- Homepage: https://pub.dev/packages/satisfied_version
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Satisfied Version
Compare and check whether the version is satisfied with provided version (or build number) in String, List, or Map.
## **Usage**
**Supports versions with format `major.minor.patch` and build number (integer).**
### **String:** Compare 2 version with conditions
``` dart
SatisfiedVersion.string('1.0.0', '>=1.0.0') // => true
SatisfiedVersion.string('1.0.0', '<=1.0.0') // => true
SatisfiedVersion.string('1.0.0', '>1.0.0') // => false
SatisfiedVersion.string('1.0.1', '>1.0.0') // => true
SatisfiedVersion.string('1.0.0', '<1.0.0') // => false
SatisfiedVersion.string('0.0.100', '>0.0.1') // => true
SatisfiedVersion.string('1.0.0', '=1.0.0') // => true
SatisfiedVersion.string('1.0.0', '==1.0.0') // => true
// Default is return `appVersion == version`
```
You can also use with integer like this:
``` dart
SatisfiedVersion.number(100, '>=100') // => true
// Supports all above operators
```
### **List:** Return `true` if there is any satisfied version in sources
``` dart
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
```
With build number:
``` dart
const versions = ['<100', '>=102'];
print(SatisfiedVersion.listNumber(100, versions)); // => false
// Supports all above operators
```
You can also compare the version within the range:
``` dart
// 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
```
With build number:
``` dart
const versionsWithin = ['>100', '<150', '160', '>=200', '<202'];
print(SatisfiedVersion.listNumber(100, versionsWithin)); // => false
// Supports all above operators
```
### **Map:** Return value of the satisfied key. Default is `false`
- `preferTrue` = `true`: Return `true` if it has at least 1 true condition.
- `preferTrue` = `false`: Return `false` if it has at least 1 false condition. Default.
``` dart
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
```
With build number:
``` dart
const versions = {'<100' : true, '>=102' : false};
print(SatisfiedVersion.map(100, versions)); // => false
// Supports all above operators
```
## Use helper to create a version in String or Interger to avoid mistake
``` dart
final version = SatisfiedVersion.createVersion(SatisfiedCondition.greater, "1.0.0"); // '>1.0.0'
final number = SatisfiedVersion.createNumber(SatisfiedCondition.greater, 100); // '>100'
```
### **Extension:** There is also a extension for String that help you easier to use this plugin
``` dart
// string
final result = '1.0.0'.satisfiedWith('<=1.0.0'); // => true
final result = '1.0.0'.satisfiedWith(['<=1.0.0', '>2.0.0']); // => true
final result = '1.0.0'.satisfiedWith({'<=1.0.0' : false}); // => false
// integer
final result = 100.satisfiedWith('<=1.0.0'); // => true
final result = 100.satisfiedWith(['<=1.0.0', '>2.0.0']); // => true
final result = 100.satisfiedWith({'<=1.0.0' : false}); // => false
```
## **Additional Parameters**
- For all:
- `defaultCondition` is the default condition if the compared version is provided without condition. Default value is `SatisfiedCondition.equal`.
- For specific `Map`:
- `defaultValue` is the default result for `Map` when `appVersion` is not in any range. Default is set to `false`.