Skip to content

Commit dff0aa2

Browse files
committed
docs: update api-reference to type installSource as InstallSource enum
1 parent 15a61d9 commit dff0aa2

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/docs/api-reference.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { VersionCheck } from 'react-native-nitro-version-check'
2020
| `version` | `string` | App version (`CFBundleShortVersionString` on iOS, `versionName` on Android) |
2121
| `buildNumber` | `string` | Build number (`CFBundleVersion` on iOS, `versionCode` on Android) |
2222
| `packageName` | `string` | Bundle ID (iOS) / Application ID (Android) |
23-
| `installSource` | `string` | `"appstore"`, `"testflight"`, `"playstore"`, or `"sideloaded"`. On iOS, `"sideloaded"` indicates a dev build. On Android, it means the app was installed via APK/ADB (dev or release). |
23+
| `installSource` | `InstallSource` | `"appstore"`, `"testflight"`, `"playstore"`, or `"sideloaded"`. On iOS, `"sideloaded"` indicates a dev build. On Android, it means the app was installed via APK/ADB (dev or release). |
2424

2525
### Methods
2626

@@ -115,6 +115,12 @@ VersionCheck.compareVersions('3.0.0', '2.9.9') // 1
115115

116116
## Types
117117

118+
### `InstallSource`
119+
120+
```ts
121+
type InstallSource = 'appstore' | 'testflight' | 'playstore' | 'sideloaded'
122+
```
123+
118124
### `UpdateLevel`
119125
120126
```ts

0 commit comments

Comments
 (0)