Skip to content

Commit 099ab06

Browse files
Updated docs for rollback retry mechanism (#1468)
1 parent 693b769 commit 099ab06

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/api-js.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The `codePush` decorator accepts an "options" object that allows you to customiz
148148

149149
* __title__ *(String)* - The text used as the header of an update notification that is displayed to the end user. Defaults to `"Update available"`.
150150

151-
* __rollbackRetryOptions__ *(RollbackRetryOptions)* - An "options" object used to determine whether a rollback retry mechanism should be enabled, and if so, what settings to use. Defaults to `null`, which has the effect of disabling the retry mechanism completely. Setting this to any truthy value will enable the retry mechanism with the default settings, and passing an object to this parameter allows enabling the retry mechanism as well as overriding one or more of the default values. The rollback retry mechanism allows the application to attempt to reinstall an update that was previously rolled back (with the restrictions specified in the options).
151+
* __rollbackRetryOptions__ *(RollbackRetryOptions)* - The rollback retry mechanism allows the application to attempt to reinstall an update that was previously rolled back (with the restrictions specified in the options). It is an "options" object used to determine whether a rollback retry should occur, and if so, what settings to use for the rollback retry. This defaults to null, which has the effect of disabling the retry mechanism. Setting this to any truthy value will enable the retry mechanism with the default settings, and passing an object to this parameter allows enabling the rollback retry as well as overriding one or more of the default values.
152152

153153
The following list represents the available options and their defaults:
154154

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,11 @@ export interface SyncOptions {
137137
updateDialog?: UpdateDialog;
138138

139139
/**
140-
* An "options" object used to determine whether a rollback retry mechanism should be enabled, and if so, what settings to use.
141-
* Defaults to `null`, which has the effect of disabling the retry mechanism completely. Setting this to any truthy value will enable
142-
* the retry mechanism with the default settings, and passing an object to this parameter allows enabling the retry mechanism as well
143-
* as overriding one or more of the default values. The rollback retry mechanism allows the application to attempt to reinstall
144-
* an update that was previously rolled back (with the restrictions specified in the options).
140+
* The rollback retry mechanism allows the application to attempt to reinstall an update that was previously rolled back (with the restrictions
141+
* specified in the options). It is an "options" object used to determine whether a rollback retry should occur, and if so, what settings to use
142+
* for the rollback retry. This defaults to null, which has the effect of disabling the retry mechanism. Setting this to any truthy value will enable
143+
* the retry mechanism with the default settings, and passing an object to this parameter allows enabling the rollback retry as well as overriding
144+
* one or more of the default values.
145145
*/
146146
rollbackRetryOptions?: RollbackRetryOptions;
147147
}

0 commit comments

Comments
 (0)