npm

Need private packages and team management tools?Check out npm Orgs. »

react-native-background-execution-ios

1.0.0 • Public • Published

react-native-background-execution-ios

React Native Background Execution Management for iOS

Installation

yarn add react-native-background-execution-ios

Automatic linking

react-native link react-native-background-execution-ios

Manual linking

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-background-execution-iosios and add RCTBackgroundExecutionIOS.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRCTBackgroundExecutionIOS.a to your project's Build PhasesLink Binary With Libraries

Usage

import BackgroundExecutionIOS from 'react-native-background-execution-ios';
 
 
const onExpiration = (remainingTime) => console.info(`Background execution time will end in ${remainingTime}s`);
const onError = (err) => console.warn(err);
 
const backgroundTimeRemaining = await BackgroundExecutionIOS.backgroundTimeRemaining;
 
if (backgroundTimeRemaining > 0) {
    BackgroundExecutionIOS.beginBackgroundTask(onExpiration, onError);
    //...
    BackgroundExecutionIOS.endBackgroundTask();
}

API

Properties

Property getters return a promise resolved with the property value.

Property Type Notes
backgroundTimeRemaining double readonly

Methods

Method Arguments Return Notes
beginBackgroundTask onExpiration: function, onError: function void
endBackgroundTask void automatically called in case of expiration

install

npm i react-native-background-execution-ios

Downloadsweekly downloads

48

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability