Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 97f84b1

Browse files
authored
Updat description for minimumBackgroundDuration (#1809)
1 parent c9f64d9 commit 97f84b1

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

typings/react-native-code-push.d.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,9 @@ export interface SyncOptions {
122122

123123
/**
124124
* Specifies the minimum number of seconds that the app needs to have been in the background before restarting the app. This property
125-
* only applies to updates which are installed using `InstallMode.ON_NEXT_RESUME`, and can be useful for getting your update in front
126-
* of end users sooner, without being too obtrusive. Defaults to `0`, which has the effect of applying the update immediately after a
127-
* resume, regardless how long it was in the background.
125+
* only applies to updates which are installed using `InstallMode.ON_NEXT_RESUME` or `InstallMode.ON_NEXT_SUSPEND`, and can be useful
126+
* for getting your update in front of end users sooner, without being too obtrusive. Defaults to `0`, which has the effect of applying
127+
* the update immediately after a resume or unless the app suspension is long enough to not matter, regardless how long it was in the background.
128128
*/
129129
minimumBackgroundDuration?: number;
130130

@@ -317,8 +317,10 @@ declare namespace CodePush {
317317
ON_NEXT_RESTART,
318318

319319
/**
320-
* Indicates that you want to install the update, but don't want to restart the
321-
* app until the next time the end user resumes it from the background.
320+
* Indicates that you want to install the update, but don't want to restart the app until the next time
321+
* the end user resumes it from the background. This way, you don't disrupt their current session,
322+
* but you can get the update in front of them sooner then having to wait for the next natural restart.
323+
* This value is appropriate for silent installs that can be applied on resume in a non-invasive way.
322324
*/
323325
ON_NEXT_RESUME,
324326

0 commit comments

Comments
 (0)