Skip to content
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.

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

docs: Clarify that update() Future only completes when download is done. #236

Merged
merged 1 commit into from
Nov 11, 2024
Merged
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions shorebird_code_push/lib/src/shorebird_updater.dart
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ abstract class ShorebirdUpdater {
Future<UpdateStatus?> checkForUpdate();

/// Updates the app to the latest patch (if available).
/// Future will complete once the update is fully downloaded and ready
/// to be used on the next app start.
/// Note: The app must be restarted for the update to take effect.
/// Note: This method does nothing if the updater is not available.
///
Expand Down
Loading