@amrshbib/react-native-background-tasks
Advanced tools
React Native background service package for continuous background tasks with sticky notifications
A powerful React Native package for running continuous background services on both Android and iOS with persistent notifications, location-based execution, and WebSocket support.
npm install @amrshbib/react-native-background-tasks
# or
yarn add @amrshbib/react-native-background-tasks
Note: This package is currently in version 1.0.0 and ready for use. The package supports both Android and iOS platforms with comprehensive background service capabilities.
This package supports auto-linking. No additional configuration is required.
For older React Native versions, you'll need to manually link the package:
react-native link @amrshbib/react-native-background-tasks
import Background from "@amrshbib/react-native-background-tasks";
// Start a background service
const startService = async () => {
try {
await Background.start(
() => {
console.log("Background task executing...");
// Your background logic here
// e.g., WebSocket connection, data sync, location tracking
},
{
taskId: "my-service",
title: "My App Service",
description: "Keeping your data synchronized",
intervalMs: 5000, // Execute every 5 seconds
}
);
console.log("Background service started successfully!");
} catch (error) {
console.error("Failed to start service:", error);
}
};
// Stop the service
const stopService = async () => {
try {
await Background.stop("my-service");
console.log("Background service stopped!");
} catch (error) {
console.error("Failed to stop service:", error);
}
};
// Check if service is running
const checkStatus = async () => {
const isRunning = await Background.isRunning("my-service");
console.log("Service running:", isRunning);
};
Background.start(taskFunction, options)Starts a background service with the specified configuration.
Parameters:
taskFunction (Function): The function to execute in the backgroundoptions (Object):
taskId (string): Unique identifier for the servicetitle (string): Notification titledescription (string): Notification descriptionintervalMs (number, optional): Execution interval in milliseconds (default: 5000)Returns: Promise<string> - Resolves when service starts successfully
Example:
await Background.start(
() => {
// Your background task
fetchDataFromAPI();
},
{
taskId: "data-sync",
title: "Data Sync",
description: "Syncing your data in background",
intervalMs: 10000,
}
);
Background.stop(taskId)Stops a running background service.
Parameters:
taskId (string): The unique identifier of the service to stopReturns: Promise<string> - Resolves when service stops successfully
Example:
await Background.stop("data-sync");
Background.isRunning(taskId)Checks if a background service is currently running.
Parameters:
taskId (string): The unique identifier of the service to checkReturns: Promise<boolean> - True if service is running, false otherwise
Example:
const isRunning = await Background.isRunning("data-sync");
The package automatically handles Android configuration, but you may need to add additional permissions to your android/app/src/main/AndroidManifest.xml:
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
<!-- Required permissions -->
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
<uses-permission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS" />
<application>
<!-- Service declaration -->
<service
android:name="com.amrshbib.reactnativebackgroundtasks.BackgroundService"
android:enabled="true"
android:exported="false"
android:foregroundServiceType="dataSync" />
</application>
</manifest>
For iOS, you need to add background modes to your ios/YourApp/Info.plist:
<key>UIBackgroundModes</key>
<array>
<string>background-processing</string>
<string>background-fetch</string>
<string>location</string>
</array>
Optional: For location-based background execution, add location usage description:
<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>This app needs location access to maintain background services.</string>
<key>NSLocationWhenInUseUsageDescription</key>
<string>This app needs location access to maintain background services.</string>
import React, { useEffect, useState } from "react";
import { View, Text, TouchableOpacity, Alert } from "react-native";
import Background from "@amrshbib/react-native-background-tasks";
const App = () => {
const [isRunning, setIsRunning] = useState(false);
const [logs, setLogs] = useState([]);
const addLog = (message) => {
const timestamp = new Date().toLocaleTimeString();
setLogs((prev) => [`[${timestamp}] ${message}`, ...prev]);
};
const startService = async () => {
try {
await Background.start(
() => {
addLog("Background task executing...");
// Your background logic here
},
{
taskId: "example-service",
title: "Example Service",
description: "Running example background task",
intervalMs: 3000,
}
);
setIsRunning(true);
addLog("Service started successfully!");
} catch (error) {
Alert.alert("Error", `Failed to start service: ${error.message}`);
}
};
const stopService = async () => {
try {
await Background.stop("example-service");
setIsRunning(false);
addLog("Service stopped!");
} catch (error) {
Alert.alert("Error", `Failed to stop service: ${error.message}`);
}
};
useEffect(() => {
// Check service status on app start
Background.isRunning("example-service").then(setIsRunning);
}, []);
return (
<View style={{ flex: 1, padding: 20 }}>
<Text style={{ fontSize: 24, marginBottom: 20 }}>Background Service Demo</Text>
<TouchableOpacity
onPress={isRunning ? stopService : startService}
style={{
backgroundColor: isRunning ? "#ff4444" : "#44ff44",
padding: 15,
borderRadius: 8,
marginBottom: 20,
}}
>
<Text style={{ color: "white", textAlign: "center", fontSize: 18 }}>{isRunning ? "Stop Service" : "Start Service"}</Text>
</TouchableOpacity>
<Text style={{ fontSize: 18, marginBottom: 10 }}>Logs:</Text>
<View style={{ flex: 1, backgroundColor: "#f0f0f0", padding: 10 }}>
{logs.map((log, index) => (
<Text key={index} style={{ fontFamily: "monospace", fontSize: 12 }}>
{log}
</Text>
))}
</View>
</View>
);
};
export default App;
Contributions are welcome! Please feel free to submit a Pull Request.
The MIT License
Copyright (c) 2024 Amr Shbib amr.shbib@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Made with ❤️ for the React Native community
FAQs
React Native background service package for continuous background tasks with sticky notifications
We found that @amrshbib/react-native-background-tasks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Security News
/Application Security
A practical guide to securing GitHub Actions against supply chain attacks, covering malicious pull requests, credential theft, dependency risks, and release pipelines.
Security News
Composer 2.11 adds dependency cooldowns, joining package managers that delay new releases to reduce supply chain risks while allowing urgent security updates.
Threat Research
/Security News
Cursor removed a malicious Claude Code 2.1.313 extension from its marketplace. Socket examines registry records and the initial claims about its distribution.