@@ -18,7 +18,7 @@ Behind the scenes, this library takes a different approach with each platform:
1818 RN's built-in [ Headless JS] ( https://facebook.github.io/react-native/docs/headless-js-android.html )
1919 (Android only).
2020 - Min API level: 16 (Android 4.1).
21- - ** iOS** : [ react-native-background-fetch] ( https://github.com/transistorsoft/react-native-background-fetch ) ,
21+ - ** iOS** : A proxy around [ react-native-background-fetch] ( https://github.com/transistorsoft/react-native-background-fetch ) ,
2222 which uses the iOS-specific ` Background Fetch ` technique.
2323
2424To achieve a unified API, this library exposes the lowest common denominator
@@ -93,11 +93,11 @@ Parameters:
9393- ** ` options? ` ** : ` Object ` - Any configuration you want to be set with
9494 the task. Note that most of these will only work on one platform.
9595
96- - ** ` period? ` ** ` number ` - (Android only) Desired number of seconds between each
96+ - ** ` period? ` ** : ` number ` - (Android only) Desired number of seconds between each
9797 execution of the task. Even on Android, the OS will only take this as a
9898 recommendation, and will enforce a minimum of 15 minutes (similar to iOS).
9999 Default is 900 (15 minutes)
100- - ** ` timeout? ` ** ` number ` - (Android only) Number of seconds the task will have
100+ - ** ` timeout? ` ** : ` number ` - (Android only) Number of seconds the task will have
101101 to execute. iOS has a hardcoded limit of 30 seconds. Default 30 seconds.
102102
103103### ` finish() `
@@ -114,13 +114,13 @@ Cancels any currently scheduled task.
114114Query the status of background tasks within this app. Returns a Promise with
115115an object of the following shape:
116116
117- - ** ` available ` ** ` boolean ` - Whether background tasks are available to the app.
117+ - ** ` available ` ** : ` boolean ` - Whether background tasks are available to the app.
118118 On Android this will always be true, but on iOS background tasks could be
119119 blocked (see [ UIBackgroundRefreshStatus] ( https://developer.apple.com/documentation/uikit/uibackgroundrefreshstatus ) ).
120- - ** ` unavailableReason? ` ** ` string ` - If unavailable, gives the reason:
121- - ** ` BackgroundTask.UNAVAILABLE_DENIED ` ** - The user explicitly disabled
120+ - ** ` unavailableReason? ` ** : ` string ` - If unavailable, gives the reason:
121+ - ** ` BackgroundTask.UNAVAILABLE_DENIED ` ** : - The user explicitly disabled
122122 background behavior for this app or for the whole system.
123- - ** ` BackgroundTask.UNAVAILABLE_RESTRICTED ` ** - Background updates
123+ - ** ` BackgroundTask.UNAVAILABLE_RESTRICTED ` ** : - Background updates
124124 unavailable and can't be enabled by the user (e.g. parental controls).
125125
126126## Caveats
0 commit comments