Skip to content

docs: fix incorrect image compression examples in README #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akhil-ge0rge wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix incorrect image compression examples in README #351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ There are several ways to use the library api.
```dart

// 1. compress file and get Uint8List
Future<Uint8List> testCompressFile(File file) async {
Future<Uint8List?> testCompressFile(File file) async {
var result = await FlutterImageCompress.compressWithFile(
file.absolute.path,
minWidth: 2300,
Expand All @@ -101,26 +101,31 @@ There are several ways to use the library api.
rotate: 90,
);
print(file.lengthSync());
print(result.length);
if (result != null) {
print(result.length);
}
return result;
}

// 2. compress file and get file.
Future<File> testCompressAndGetFile(File file, String targetPath) async {
Future<File?> testCompressAndGetFile(File file, String targetPath) async {
var result = await FlutterImageCompress.compressAndGetFile(
file.absolute.path, targetPath,
quality: 88,
rotate: 180,
);

print(file.lengthSync());
print(result.lengthSync());
if (result != null) {
print(await result.length());
return File(result.path);
}

return result;
}

// 3. compress asset and get Uint8List.
Future<Uint8List> testCompressAsset(String assetName) async {
Future<Uint8List?> testCompressAsset(String assetName) async {
var list = await FlutterImageCompress.compressAssetImage(
assetName,
minHeight: 1920,
Expand Down