@capacitor/background-runner 1.0.6-dev-20260203T091959.0 → 1.0.6-dev-20260727T173112.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -8
- package/dist/docs-api.json +1 -1
- package/dist/docs.json +1 -1
- package/dist/esm/definitions.d.ts +2 -2
- package/dist/esm/definitions.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -189,14 +189,14 @@ On load, Background Runner will automatically register a
|
|
|
189
189
|
background task that will be scheduled and run once your app is
|
|
190
190
|
backgrounded.
|
|
191
191
|
|
|
192
|
-
| Prop | Type | Description
|
|
193
|
-
| --------------- | -------------------- |
|
|
194
|
-
| **`label`** | <code>string</code> | The name of the runner, used in logs.
|
|
195
|
-
| **`src`** | <code>string</code> | The path to the runner JavaScript file, relative to the app bundle.
|
|
196
|
-
| **`event`** | <code>string</code> | The name of the event that will be called when the OS executes the background task.
|
|
197
|
-
| **`repeat`** | <code>boolean</code> | If background task should repeat based on the interval set in `interval`.
|
|
198
|
-
| **`interval`** | <code>number</code> | The number of minutes after the
|
|
199
|
-
| **`autoStart`** | <code>boolean</code> | Automatically register and schedule background task on app load.
|
|
192
|
+
| Prop | Type | Description | Since |
|
|
193
|
+
| --------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
|
|
194
|
+
| **`label`** | <code>string</code> | The name of the runner, used in logs. | 1.0.0 |
|
|
195
|
+
| **`src`** | <code>string</code> | The path to the runner JavaScript file, relative to the app bundle. | 1.0.0 |
|
|
196
|
+
| **`event`** | <code>string</code> | The name of the event that will be called when the OS executes the background task. | 1.0.0 |
|
|
197
|
+
| **`repeat`** | <code>boolean</code> | If background task should repeat based on the interval set in `interval`. | 1.0.0 |
|
|
198
|
+
| **`interval`** | <code>number</code> | The number of minutes after the app is put into the background in which the background task should begin. If `repeat` is true, this also specifies the number of minutes between each execution. | 1.0.0 |
|
|
199
|
+
| **`autoStart`** | <code>boolean</code> | Automatically register and schedule background task on app load. | 1.0.0 |
|
|
200
200
|
|
|
201
201
|
### Examples
|
|
202
202
|
|
package/dist/docs-api.json
CHANGED
|
@@ -948,7 +948,7 @@
|
|
|
948
948
|
"name": "example"
|
|
949
949
|
}
|
|
950
950
|
],
|
|
951
|
-
"docs": "The number of minutes after the
|
|
951
|
+
"docs": "The number of minutes after the app is put into the background in which the background task should begin.\n\nIf `repeat` is true, this also specifies the number of minutes between each execution.",
|
|
952
952
|
"complexTypes": [],
|
|
953
953
|
"type": "number"
|
|
954
954
|
},
|
package/dist/docs.json
CHANGED
|
@@ -369,7 +369,7 @@
|
|
|
369
369
|
"name": "example"
|
|
370
370
|
}
|
|
371
371
|
],
|
|
372
|
-
"docs": "The number of minutes after the
|
|
372
|
+
"docs": "The number of minutes after the app is put into the background in which the background task should begin.\n\nIf `repeat` is true, this also specifies the number of minutes between each execution.",
|
|
373
373
|
"complexTypes": [],
|
|
374
374
|
"type": "number"
|
|
375
375
|
},
|
|
@@ -25,7 +25,7 @@ export interface BackgroundRunnerConfig {
|
|
|
25
25
|
*/
|
|
26
26
|
repeat: boolean;
|
|
27
27
|
/**
|
|
28
|
-
* The number of minutes after the
|
|
28
|
+
* The number of minutes after the app is put into the background in which the background task should begin.
|
|
29
29
|
*
|
|
30
30
|
* If `repeat` is true, this also specifies the number of minutes between each execution.
|
|
31
31
|
*
|
|
@@ -76,7 +76,7 @@ declare module '@capacitor/cli' {
|
|
|
76
76
|
*/
|
|
77
77
|
repeat: boolean;
|
|
78
78
|
/**
|
|
79
|
-
* The number of minutes after the
|
|
79
|
+
* The number of minutes after the app is put into the background in which the background task should begin.
|
|
80
80
|
*
|
|
81
81
|
* If `repeat` is true, this also specifies the number of minutes between each execution.
|
|
82
82
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport interface BackgroundRunnerConfig {\n /**\n * The name of the runner, used in logs.\n *\n * @since 1.0.0\n */\n label: string;\n /**\n * The path to the runner JavaScript file, relative to the app bundle.\n *\n * @since 1.0.0\n */\n src: string;\n /**\n * The name of the event that will be called when the OS executes the background task.\n *\n * @since 1.0.0\n */\n event: string;\n /**\n * If background task should repeat based on the interval set in `interval`.\n *\n * @since 1.0.0\n */\n repeat: boolean;\n /**\n * The number of minutes after the
|
|
1
|
+
{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAAA,wCAAwC","sourcesContent":["/// <reference types=\"@capacitor/cli\" />\n\nimport type { PermissionState, PluginListenerHandle } from '@capacitor/core';\n\nexport interface BackgroundRunnerConfig {\n /**\n * The name of the runner, used in logs.\n *\n * @since 1.0.0\n */\n label: string;\n /**\n * The path to the runner JavaScript file, relative to the app bundle.\n *\n * @since 1.0.0\n */\n src: string;\n /**\n * The name of the event that will be called when the OS executes the background task.\n *\n * @since 1.0.0\n */\n event: string;\n /**\n * If background task should repeat based on the interval set in `interval`.\n *\n * @since 1.0.0\n */\n repeat: boolean;\n /**\n * The number of minutes after the app is put into the background in which the background task should begin.\n *\n * If `repeat` is true, this also specifies the number of minutes between each execution.\n *\n * @since 1.0.0\n */\n interval: number;\n /**\n * Automatically register and schedule background task on app load.\n *\n * @since 1.0.0\n */\n autoStart?: boolean;\n}\n\ndeclare module '@capacitor/cli' {\n export interface PluginsConfig {\n /**\n * On load, Background Runner will automatically register a\n * background task that will be scheduled and run once your app is\n * backgrounded.\n */\n BackgroundRunner?: {\n /**\n * The name of the runner, used in logs.\n *\n * @since 1.0.0\n * @example \"com.example.background.task\"\n */\n label: string;\n /**\n * The path to the runner JavaScript file, relative to the app bundle.\n *\n * @since 1.0.0\n * @example \"runners/background.js\"\n */\n src: string;\n /**\n * The name of the event that will be called when the OS executes the background task.\n *\n * @since 1.0.0\n * @example \"myCustomEvent\"\n */\n event: string;\n /**\n * If background task should repeat based on the interval set in `interval`.\n *\n * @since 1.0.0\n * @example true\n */\n repeat: boolean;\n /**\n * The number of minutes after the app is put into the background in which the background task should begin.\n *\n * If `repeat` is true, this also specifies the number of minutes between each execution.\n *\n * @since 1.0.0\n * @example 15\n */\n interval: number;\n /**\n * Automatically register and schedule background task on app load.\n *\n * @since 1.0.0\n * @example true\n */\n autoStart?: boolean;\n };\n }\n}\n\nexport type API = 'geolocation' | 'notifications';\n\nexport interface PermissionStatus {\n geolocation: PermissionState;\n notifications: PermissionState;\n}\n\nexport interface DispatchEventOptions {\n /**\n * The runner label to dispatch the event to\n *\n * @since 1.0.0\n */\n label: string;\n /**\n * The name of the registered event listener.\n *\n * @since 1.0.0\n */\n event: string;\n details: { [key: string]: any };\n}\n\nexport interface RequestPermissionOptions {\n apis: API[];\n}\n\nexport interface RegisterBackgroundTaskOptions {\n runner: BackgroundRunnerConfig;\n}\n\nexport interface NotificationActionEvent {\n actionTypeId: string;\n notificationId: number;\n}\n\nexport interface BackgroundRunnerPlugin {\n /**\n * Check permissions for the various Capacitor device APIs.\n *\n * @since 1.0.0\n */\n checkPermissions(): Promise<PermissionStatus>;\n /**\n * Request permission to display local notifications.\n *\n * @since 1.0.0\n */\n requestPermissions(options: RequestPermissionOptions): Promise<PermissionStatus>;\n /**\n * Dispatches an event to the configured runner.\n * @param options\n * @since 1.0.0\n */\n dispatchEvent<T = void>(options: DispatchEventOptions): Promise<T>;\n /**\n * Add a listener for notification actions.\n *\n * @since 2.1.1\n */\n addListener(\n eventName: 'backgroundRunnerNotificationReceived',\n listenerFunc: (event: NotificationActionEvent) => void,\n ): Promise<PluginListenerHandle>;\n /**\n * Remove notification action listeners for this plugin.\n *\n * @since 2.1.1\n */\n removeNotificationListeners(): Promise<void>;\n}\n\ndeclare module '@capacitor/cli' {\n export interface PluginsConfig {\n BackgroundRunner?: BackgroundRunnerConfig;\n }\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@capacitor/background-runner",
|
|
3
|
-
"version": "1.0.6-dev-
|
|
3
|
+
"version": "1.0.6-dev-20260727T173112.0",
|
|
4
4
|
"description": "Capacitor Background Runner",
|
|
5
5
|
"main": "dist/plugin.cjs.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -83,5 +83,5 @@
|
|
|
83
83
|
"src": "android"
|
|
84
84
|
}
|
|
85
85
|
},
|
|
86
|
-
"gitHead": "
|
|
86
|
+
"gitHead": "0d5f351f2738b9a3a763922e2b066357a1c39240"
|
|
87
87
|
}
|