Skip to content

Commit ffaaf7f

Browse files
committed
chore: update generated js doc
1 parent c18933f commit ffaaf7f

29 files changed

+130
-122
lines changed

docs/api-js/enumerations/CheckFrequency.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Enumeration: CheckFrequency
88

9-
Defined in: [enums/CheckFrequency.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L4)
9+
Defined in: [enums/CheckFrequency.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L4)
1010

1111
Indicates when you would like to check for (and install) updates from the CodePush server.
1212

@@ -16,7 +16,7 @@ Indicates when you would like to check for (and install) updates from the CodePu
1616

1717
> **MANUAL**: `2`
1818
19-
Defined in: [enums/CheckFrequency.enum.ts:18](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L18)
19+
Defined in: [enums/CheckFrequency.enum.ts:18](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L18)
2020

2121
Don't automatically check for updates, but only do it when `sync()` is manually called in app code.
2222

@@ -26,7 +26,7 @@ Don't automatically check for updates, but only do it when `sync()` is manually
2626

2727
> **ON_APP_RESUME**: `1`
2828
29-
Defined in: [enums/CheckFrequency.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L13)
29+
Defined in: [enums/CheckFrequency.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L13)
3030

3131
When the app re-enters the foreground after being "backgrounded" (user pressed the home button, app launches a separate payment process, etc.)
3232

@@ -36,6 +36,6 @@ When the app re-enters the foreground after being "backgrounded" (user pressed t
3636

3737
> **ON_APP_START**: `0`
3838
39-
Defined in: [enums/CheckFrequency.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/CheckFrequency.enum.ts#L8)
39+
Defined in: [enums/CheckFrequency.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/CheckFrequency.enum.ts#L8)
4040

4141
When the app is fully initialized (or more specifically, when the root component is mounted).

docs/api-js/enumerations/DeploymentStatus.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Enumeration: DeploymentStatus
88

9-
Defined in: [enums/DeploymentStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/DeploymentStatus.enum.ts#L4)
9+
Defined in: [enums/DeploymentStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L4)
1010

1111
Indicates the status of a deployment (after installing and restarting).
1212

@@ -16,7 +16,7 @@ Indicates the status of a deployment (after installing and restarting).
1616

1717
> **FAILED**: `"DeploymentFailed"`
1818
19-
Defined in: [enums/DeploymentStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/DeploymentStatus.enum.ts#L8)
19+
Defined in: [enums/DeploymentStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L8)
2020

2121
The deployment failed (and was rolled back).
2222

@@ -26,6 +26,6 @@ The deployment failed (and was rolled back).
2626

2727
> **SUCCEEDED**: `"DeploymentSucceeded"`
2828
29-
Defined in: [enums/DeploymentStatus.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/DeploymentStatus.enum.ts#L13)
29+
Defined in: [enums/DeploymentStatus.enum.ts:13](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/DeploymentStatus.enum.ts#L13)
3030

3131
The deployment succeeded.

docs/api-js/enumerations/InstallMode.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Enumeration: InstallMode
88

9-
Defined in: [enums/InstallMode.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L6)
9+
Defined in: [enums/InstallMode.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L6)
1010

1111
Indicates when you would like an installed update to actually be applied.
1212

@@ -16,7 +16,7 @@ Indicates when you would like an installed update to actually be applied.
1616

1717
> **IMMEDIATE**: `number`
1818
19-
Defined in: [enums/InstallMode.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L12)
19+
Defined in: [enums/InstallMode.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L12)
2020

2121
Indicates that you want to install the update and restart the app immediately.
2222

@@ -28,7 +28,7 @@ This value is appropriate for debugging scenarios as well as when displaying an
2828

2929
> **ON_NEXT_RESTART**: `number`
3030
31-
Defined in: [enums/InstallMode.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L19)
31+
Defined in: [enums/InstallMode.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L19)
3232

3333
Indicates that you want to install the update, but not forcibly restart the app.
3434

@@ -40,7 +40,7 @@ When the app is "naturally" restarted (due the OS or end user killing it), the u
4040

4141
> **ON_NEXT_RESUME**: `number`
4242
43-
Defined in: [enums/InstallMode.enum.ts:27](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L27)
43+
Defined in: [enums/InstallMode.enum.ts:27](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L27)
4444

4545
Indicates that you want to install the update, but don't want to restart the app until the next time the end user resumes it from the background.
4646

@@ -53,7 +53,7 @@ This value is appropriate for silent installs that can be applied on resume in a
5353

5454
> **ON_NEXT_SUSPEND**: `number`
5555
56-
Defined in: [enums/InstallMode.enum.ts:34](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/InstallMode.enum.ts#L34)
56+
Defined in: [enums/InstallMode.enum.ts:34](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/InstallMode.enum.ts#L34)
5757

5858
Indicates that you want to install the update when the app is in the background,
5959
but only after it has been in the background for "minimumBackgroundDuration" seconds (0 by default),

docs/api-js/enumerations/SyncStatus.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Enumeration: SyncStatus
88

9-
Defined in: [enums/SyncStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L4)
9+
Defined in: [enums/SyncStatus.enum.ts:4](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L4)
1010

1111
Indicates the current status of a sync operation.
1212

@@ -16,7 +16,7 @@ Indicates the current status of a sync operation.
1616

1717
> **AWAITING_USER_ACTION**: `6`
1818
19-
Defined in: [enums/SyncStatus.enum.ts:42](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L42)
19+
Defined in: [enums/SyncStatus.enum.ts:42](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L42)
2020

2121
An update is available, and a confirmation dialog was shown
2222
to the end user. (This is only applicable when the `updateDialog` is used)
@@ -27,7 +27,7 @@ to the end user. (This is only applicable when the `updateDialog` is used)
2727

2828
> **CHECKING_FOR_UPDATE**: `5`
2929
30-
Defined in: [enums/SyncStatus.enum.ts:36](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L36)
30+
Defined in: [enums/SyncStatus.enum.ts:36](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L36)
3131

3232
The CodePush server is being queried for an update.
3333

@@ -37,7 +37,7 @@ The CodePush server is being queried for an update.
3737

3838
> **DOWNLOADING_PACKAGE**: `7`
3939
40-
Defined in: [enums/SyncStatus.enum.ts:47](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L47)
40+
Defined in: [enums/SyncStatus.enum.ts:47](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L47)
4141

4242
An available update is being downloaded from the CodePush server.
4343

@@ -47,7 +47,7 @@ An available update is being downloaded from the CodePush server.
4747

4848
> **INSTALLING_UPDATE**: `8`
4949
50-
Defined in: [enums/SyncStatus.enum.ts:52](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L52)
50+
Defined in: [enums/SyncStatus.enum.ts:52](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L52)
5151

5252
An available update was downloaded and is about to be installed.
5353

@@ -57,7 +57,7 @@ An available update was downloaded and is about to be installed.
5757

5858
> **SYNC_IN_PROGRESS**: `4`
5959
60-
Defined in: [enums/SyncStatus.enum.ts:31](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L31)
60+
Defined in: [enums/SyncStatus.enum.ts:31](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L31)
6161

6262
There is an ongoing `sync` operation running which prevents the current call from being executed.
6363

@@ -67,7 +67,7 @@ There is an ongoing `sync` operation running which prevents the current call fro
6767

6868
> **UNKNOWN_ERROR**: `3`
6969
70-
Defined in: [enums/SyncStatus.enum.ts:26](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L26)
70+
Defined in: [enums/SyncStatus.enum.ts:26](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L26)
7171

7272
The `sync` operation encountered an unknown error.
7373

@@ -77,7 +77,7 @@ The `sync` operation encountered an unknown error.
7777

7878
> **UP_TO_DATE**: `0`
7979
80-
Defined in: [enums/SyncStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L8)
80+
Defined in: [enums/SyncStatus.enum.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L8)
8181

8282
The app is fully up-to-date with the configured release channel.
8383

@@ -87,7 +87,7 @@ The app is fully up-to-date with the configured release channel.
8787

8888
> **UPDATE_IGNORED**: `2`
8989
90-
Defined in: [enums/SyncStatus.enum.ts:21](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L21)
90+
Defined in: [enums/SyncStatus.enum.ts:21](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L21)
9191

9292
The app had an optional update which the end user chose to ignore.
9393
(This is only applicable when the `updateDialog` is used)
@@ -98,7 +98,7 @@ The app had an optional update which the end user chose to ignore.
9898

9999
> **UPDATE_INSTALLED**: `1`
100100
101-
Defined in: [enums/SyncStatus.enum.ts:15](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/SyncStatus.enum.ts#L15)
101+
Defined in: [enums/SyncStatus.enum.ts:15](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/SyncStatus.enum.ts#L15)
102102

103103
An available update has been installed and will be run either immediately after the
104104
`syncStatusChangedCallback` function returns or the next time the app resumes/restarts,

docs/api-js/enumerations/UpdateState.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Enumeration: UpdateState
88

9-
Defined in: [enums/UpdateState.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L6)
9+
Defined in: [enums/UpdateState.enum.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L6)
1010

1111
Indicates the state that an update is currently in.
1212

@@ -16,7 +16,7 @@ Indicates the state that an update is currently in.
1616

1717
> **LATEST**: `number`
1818
19-
Defined in: [enums/UpdateState.enum.ts:24](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L24)
19+
Defined in: [enums/UpdateState.enum.ts:24](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L24)
2020

2121
Indicates than an update represents the latest available release, and can be either currently running or pending.
2222

@@ -26,7 +26,7 @@ Indicates than an update represents the latest available release, and can be eit
2626

2727
> **PENDING**: `number`
2828
29-
Defined in: [enums/UpdateState.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L19)
29+
Defined in: [enums/UpdateState.enum.ts:19](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L19)
3030

3131
Indicates than an update has been installed, but the app hasn't been restarted yet in order to apply it.
3232

@@ -38,7 +38,7 @@ This can be useful for determining whether there is a pending update, which you
3838

3939
> **RUNNING**: `number`
4040
41-
Defined in: [enums/UpdateState.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/enums/UpdateState.enum.ts#L12)
41+
Defined in: [enums/UpdateState.enum.ts:12](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/enums/UpdateState.enum.ts#L12)
4242

4343
Indicates that an update represents the version of the app that is currently running.
4444

docs/api-js/functions/allowRestart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **allowRestart**(): `void`
1010
11-
Defined in: [allowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/allowRestart.ts#L8)
11+
Defined in: [allowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/allowRestart.ts#L8)
1212

1313
Allow CodePush to restart the app.
1414

docs/api-js/functions/checkForUpdate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **checkForUpdate**(`releaseChannelPublicId`?, `handleBinaryVersionMismatchCallback`?): `Promise`\<`null` \| [`RemotePackage`](../interfaces/RemotePackage.md)\>
1010
11-
Defined in: [checkForUpdates.ts:18](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/checkForUpdates.ts#L18)
11+
Defined in: [checkForUpdates.ts:18](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/checkForUpdates.ts#L18)
1212

1313
Asks the CodePush service whether the configured app release channel has an update available.
1414

docs/api-js/functions/clearUpdates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **clearUpdates**(): `void`
1010
11-
Defined in: [clearUpdates.ts:10](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/clearUpdates.ts#L10)
11+
Defined in: [clearUpdates.ts:10](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/clearUpdates.ts#L10)
1212

1313
Clears all downloaded CodePush updates.
1414

docs/api-js/functions/disallowRestart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **disallowRestart**(): `void`
1010
11-
Defined in: [disallowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/disallowRestart.ts#L8)
11+
Defined in: [disallowRestart.ts:8](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/disallowRestart.ts#L8)
1212

1313
Forbid CodePush to restart the app.
1414

docs/api-js/functions/getClientUniqueId.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **getClientUniqueId**(): `Promise`\<`string`\>
1010
11-
Defined in: [getClientUniqueId.ts:6](https://github.com/AppZung/react-native-code-push/blob/5f900017beec34f1e037ac881585c7f5fb00d5dd/src/getClientUniqueId.ts#L6)
11+
Defined in: [getClientUniqueId.ts:6](https://github.com/AppZung/react-native-code-push/blob/c18933fc82ce614eded3156d1f391ab8a21d21d7/src/getClientUniqueId.ts#L6)
1212

1313
Gets the client's unique ID set by the module. You may also see `resetClientUniqueId`.
1414

0 commit comments

Comments
 (0)