@capgo/capacitor-background-task 8.1.0

package/dist/docs.json

@@ -0,0 +1,407 @@
+{
+  "api": {
+    "name": "BackgroundTaskPlugin",
+    "slug": "backgroundtaskplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "defineTask",
+        "signature": "(taskName: string, callback: BackgroundTaskCallback) => void",
+        "parameters": [
+          {
+            "name": "taskName",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "callback",
+            "docs": "",
+            "type": "BackgroundTaskCallback"
+          }
+        ],
+        "returns": "void",
+        "tags": [],
+        "docs": "Define the JavaScript callback for a task. Call this at module/global scope.",
+        "complexTypes": [
+          "BackgroundTaskCallback"
+        ],
+        "slug": "definetask"
+      },
+      {
+        "name": "registerTaskAsync",
+        "signature": "(taskName: string, options?: BackgroundTaskOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "taskName",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "BackgroundTaskOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Register a named periodic background task.",
+        "complexTypes": [
+          "BackgroundTaskOptions"
+        ],
+        "slug": "registertaskasync"
+      },
+      {
+        "name": "unregisterTaskAsync",
+        "signature": "(taskName: string) => Promise<void>",
+        "parameters": [
+          {
+            "name": "taskName",
+            "docs": "",
+            "type": "string"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Unregister a named periodic background task.",
+        "complexTypes": [],
+        "slug": "unregistertaskasync"
+      },
+      {
+        "name": "isTaskRegisteredAsync",
+        "signature": "(taskName: string) => Promise<boolean>",
+        "parameters": [
+          {
+            "name": "taskName",
+            "docs": "",
+            "type": "string"
+          }
+        ],
+        "returns": "Promise<boolean>",
+        "tags": [],
+        "docs": "Check whether a named task is registered.",
+        "complexTypes": [],
+        "slug": "istaskregisteredasync"
+      },
+      {
+        "name": "getRegisteredTasksAsync",
+        "signature": "() => Promise<string[]>",
+        "parameters": [],
+        "returns": "Promise<string[]>",
+        "tags": [],
+        "docs": "Return all registered task names.",
+        "complexTypes": [],
+        "slug": "getregisteredtasksasync"
+      },
+      {
+        "name": "getPendingTaskRunsAsync",
+        "signature": "() => Promise<BackgroundTaskEvent[]>",
+        "parameters": [],
+        "returns": "Promise<BackgroundTaskEvent[]>",
+        "tags": [],
+        "docs": "Return pending task runs that native recorded before JavaScript was ready.",
+        "complexTypes": [
+          "BackgroundTaskEvent"
+        ],
+        "slug": "getpendingtaskrunsasync"
+      },
+      {
+        "name": "getStatusAsync",
+        "signature": "() => Promise<BackgroundTaskStatus>",
+        "parameters": [],
+        "returns": "Promise<BackgroundTaskStatus>",
+        "tags": [],
+        "docs": "Return native background task availability.",
+        "complexTypes": [
+          "BackgroundTaskStatus"
+        ],
+        "slug": "getstatusasync"
+      },
+      {
+        "name": "triggerTaskWorkerForTestingAsync",
+        "signature": "() => Promise<boolean>",
+        "parameters": [],
+        "returns": "Promise<boolean>",
+        "tags": [],
+        "docs": "Trigger all registered tasks immediately for development/testing.",
+        "complexTypes": [],
+        "slug": "triggertaskworkerfortestingasync"
+      },
+      {
+        "name": "addExpirationListener",
+        "signature": "(listener: (event: BackgroundTaskEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "listener",
+            "docs": "",
+            "type": "(event: BackgroundTaskEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for iOS expiration callbacks.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "BackgroundTaskEvent"
+        ],
+        "slug": "addexpirationlistener"
+      },
+      {
+        "name": "define",
+        "signature": "(callback: BackgroundTaskCallback) => void",
+        "parameters": [
+          {
+            "name": "callback",
+            "docs": "",
+            "type": "BackgroundTaskCallback"
+          }
+        ],
+        "returns": "void",
+        "tags": [],
+        "docs": "React Native background-task compatible single-task define helper.",
+        "complexTypes": [
+          "BackgroundTaskCallback"
+        ],
+        "slug": "define"
+      },
+      {
+        "name": "schedule",
+        "signature": "(options?: ReactNativeBackgroundTaskOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ReactNativeBackgroundTaskOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "React Native background-task compatible single-task scheduler.",
+        "complexTypes": [
+          "ReactNativeBackgroundTaskOptions"
+        ],
+        "slug": "schedule"
+      },
+      {
+        "name": "cancel",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "React Native background-task compatible single-task cancel helper.",
+        "complexTypes": [],
+        "slug": "cancel"
+      },
+      {
+        "name": "statusAsync",
+        "signature": "() => Promise<ReactNativeBackgroundTaskStatus>",
+        "parameters": [],
+        "returns": "Promise<ReactNativeBackgroundTaskStatus>",
+        "tags": [],
+        "docs": "React Native background-task compatible status helper.",
+        "complexTypes": [
+          "ReactNativeBackgroundTaskStatus"
+        ],
+        "slug": "statusasync"
+      },
+      {
+        "name": "finish",
+        "signature": "(result?: BackgroundTaskResult | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "result",
+            "docs": "",
+            "type": "BackgroundTaskResult | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "React Native background-task compatible finish helper. Normal Expo-style\ncallbacks are finished automatically.",
+        "complexTypes": [
+          "BackgroundTaskResult"
+        ],
+        "slug": "finish"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "BackgroundTaskEvent",
+      "slug": "backgroundtaskevent",
+      "docs": "Payload emitted when native scheduling asks JavaScript to run a task.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "taskName",
+          "tags": [],
+          "docs": "Name passed to registerTaskAsync.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "taskId",
+          "tags": [],
+          "docs": "Native run identifier. The JavaScript wrapper finishes it automatically\nwhen the defined callback resolves.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "timestamp",
+          "tags": [],
+          "docs": "Native timestamp for the run.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "test",
+          "tags": [],
+          "docs": "True when triggered through triggerTaskWorkerForTestingAsync.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "BackgroundTaskOptions",
+      "slug": "backgroundtaskoptions",
+      "docs": "Options for registering a periodic background task.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "minimumInterval",
+          "tags": [],
+          "docs": "Inexact interval in minutes between task runs.\n\nDefaults to 720 minutes. Android enforces a 15 minute minimum. iOS treats\nthis as an earliest begin date and may run much later.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "requiresNetwork",
+          "tags": [],
+          "docs": "Require an active network before running the native scheduler.\n\nDefaults to true.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "ReactNativeBackgroundTaskOptions",
+      "slug": "reactnativebackgroundtaskoptions",
+      "docs": "React Native background-task compatible schedule options.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "period",
+          "tags": [],
+          "docs": "Desired seconds between each execution. Mapped to minimumInterval minutes.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "timeout",
+          "tags": [],
+          "docs": "Android-only timeout hint kept for API compatibility.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ReactNativeBackgroundTaskStatus",
+      "slug": "reactnativebackgroundtaskstatus",
+      "docs": "React Native background-task compatible status payload.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "available",
+          "tags": [],
+          "docs": "Whether background tasks are available to the app.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "unavailableReason",
+          "tags": [],
+          "docs": "Reason when unavailable.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "BackgroundTaskResult",
+      "slug": "backgroundtaskresult",
+      "members": [
+        {
+          "name": "Success",
+          "value": "1",
+          "tags": [],
+          "docs": "The task finished successfully."
+        },
+        {
+          "name": "Failed",
+          "value": "2",
+          "tags": [],
+          "docs": "The task failed."
+        }
+      ]
+    },
+    {
+      "name": "BackgroundTaskStatus",
+      "slug": "backgroundtaskstatus",
+      "members": [
+        {
+          "name": "Restricted",
+          "value": "1",
+          "tags": [],
+          "docs": "Background task scheduling is unavailable or restricted."
+        },
+        {
+          "name": "Available",
+          "value": "2",
+          "tags": [],
+          "docs": "Background task scheduling is available."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "BackgroundTaskCallback",
+      "slug": "backgroundtaskcallback",
+      "docs": "Function executed for a background task.",
+      "types": [
+        {
+          "text": "(event: BackgroundTaskEvent): void | BackgroundTaskResult | Promise<void | BackgroundTaskResult>",
+          "complexTypes": [
+            "BackgroundTaskEvent",
+            "BackgroundTaskResult"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,192 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+/**
+ * Return value for a background task callback.
+ */
+export declare enum BackgroundTaskResult {
+    /**
+     * The task finished successfully.
+     */
+    Success = 1,
+    /**
+     * The task failed.
+     */
+    Failed = 2
+}
+/**
+ * Availability status for background task scheduling.
+ */
+export declare enum BackgroundTaskStatus {
+    /**
+     * Background task scheduling is unavailable or restricted.
+     */
+    Restricted = 1,
+    /**
+     * Background task scheduling is available.
+     */
+    Available = 2
+}
+/**
+ * Options for registering a periodic background task.
+ */
+export interface BackgroundTaskOptions {
+    /**
+     * Inexact interval in minutes between task runs.
+     *
+     * Defaults to 720 minutes. Android enforces a 15 minute minimum. iOS treats
+     * this as an earliest begin date and may run much later.
+     */
+    minimumInterval?: number;
+    /**
+     * Require an active network before running the native scheduler.
+     *
+     * Defaults to true.
+     */
+    requiresNetwork?: boolean;
+}
+/**
+ * Payload emitted when native scheduling asks JavaScript to run a task.
+ */
+export interface BackgroundTaskEvent {
+    /**
+     * Name passed to registerTaskAsync.
+     */
+    taskName: string;
+    /**
+     * Native run identifier. The JavaScript wrapper finishes it automatically
+     * when the defined callback resolves.
+     */
+    taskId: string;
+    /**
+     * Native timestamp for the run.
+     */
+    timestamp: number;
+    /**
+     * True when triggered through triggerTaskWorkerForTestingAsync.
+     */
+    test?: boolean;
+}
+/**
+ * Function executed for a background task.
+ */
+export type BackgroundTaskCallback = (event: BackgroundTaskEvent) => Promise<BackgroundTaskResult | void> | BackgroundTaskResult | void;
+/**
+ * React Native background-task compatible schedule options.
+ */
+export interface ReactNativeBackgroundTaskOptions {
+    /**
+     * Desired seconds between each execution. Mapped to minimumInterval minutes.
+     */
+    period?: number;
+    /**
+     * Android-only timeout hint kept for API compatibility.
+     */
+    timeout?: number;
+}
+/**
+ * React Native background-task compatible status payload.
+ */
+export interface ReactNativeBackgroundTaskStatus {
+    /**
+     * Whether background tasks are available to the app.
+     */
+    available: boolean;
+    /**
+     * Reason when unavailable.
+     */
+    unavailableReason?: string;
+}
+export interface GetStatusResult {
+    status: BackgroundTaskStatus;
+}
+export interface BooleanResult {
+    value: boolean;
+}
+export interface PendingTaskRunsResult {
+    tasks: BackgroundTaskEvent[];
+}
+export interface RegisteredTasksResult {
+    tasks: string[];
+}
+export interface FinishOptions {
+    taskId: string;
+    taskName?: string;
+    result?: BackgroundTaskResult;
+}
+export interface RegisterTaskOptions {
+    taskName: string;
+    options?: BackgroundTaskOptions;
+}
+export interface TaskNameOptions {
+    taskName: string;
+}
+export interface NativeBackgroundTaskPlugin {
+    registerTask(options: RegisterTaskOptions): Promise<void>;
+    unregisterTask(options: TaskNameOptions): Promise<void>;
+    isTaskRegistered(options: TaskNameOptions): Promise<BooleanResult>;
+    getRegisteredTasks(): Promise<RegisteredTasksResult>;
+    getPendingTaskRuns(): Promise<PendingTaskRunsResult>;
+    getStatus(): Promise<GetStatusResult>;
+    triggerTaskWorkerForTesting(): Promise<BooleanResult>;
+    finish(options: FinishOptions): Promise<void>;
+    addListener(eventName: 'backgroundTask', listenerFunc: (event: BackgroundTaskEvent) => void): Promise<PluginListenerHandle>;
+    addListener(eventName: 'expiration', listenerFunc: (event: BackgroundTaskEvent) => void): Promise<PluginListenerHandle>;
+}
+export interface BackgroundTaskPlugin {
+    /**
+     * Define the JavaScript callback for a task. Call this at module/global scope.
+     */
+    defineTask(taskName: string, callback: BackgroundTaskCallback): void;
+    /**
+     * Register a named periodic background task.
+     */
+    registerTaskAsync(taskName: string, options?: BackgroundTaskOptions): Promise<void>;
+    /**
+     * Unregister a named periodic background task.
+     */
+    unregisterTaskAsync(taskName: string): Promise<void>;
+    /**
+     * Check whether a named task is registered.
+     */
+    isTaskRegisteredAsync(taskName: string): Promise<boolean>;
+    /**
+     * Return all registered task names.
+     */
+    getRegisteredTasksAsync(): Promise<string[]>;
+    /**
+     * Return pending task runs that native recorded before JavaScript was ready.
+     */
+    getPendingTaskRunsAsync(): Promise<BackgroundTaskEvent[]>;
+    /**
+     * Return native background task availability.
+     */
+    getStatusAsync(): Promise<BackgroundTaskStatus>;
+    /**
+     * Trigger all registered tasks immediately for development/testing.
+     */
+    triggerTaskWorkerForTestingAsync(): Promise<boolean>;
+    /**
+     * Listen for iOS expiration callbacks.
+     */
+    addExpirationListener(listener: (event: BackgroundTaskEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * React Native background-task compatible single-task define helper.
+     */
+    define(callback: BackgroundTaskCallback): void;
+    /**
+     * React Native background-task compatible single-task scheduler.
+     */
+    schedule(options?: ReactNativeBackgroundTaskOptions): Promise<void>;
+    /**
+     * React Native background-task compatible single-task cancel helper.
+     */
+    cancel(): Promise<void>;
+    /**
+     * React Native background-task compatible status helper.
+     */
+    statusAsync(): Promise<ReactNativeBackgroundTaskStatus>;
+    /**
+     * React Native background-task compatible finish helper. Normal Expo-style
+     * callbacks are finished automatically.
+     */
+    finish(result?: BackgroundTaskResult): Promise<void>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,29 @@
+/**
+ * Return value for a background task callback.
+ */
+export var BackgroundTaskResult;
+(function (BackgroundTaskResult) {
+    /**
+     * The task finished successfully.
+     */
+    BackgroundTaskResult[BackgroundTaskResult["Success"] = 1] = "Success";
+    /**
+     * The task failed.
+     */
+    BackgroundTaskResult[BackgroundTaskResult["Failed"] = 2] = "Failed";
+})(BackgroundTaskResult || (BackgroundTaskResult = {}));
+/**
+ * Availability status for background task scheduling.
+ */
+export var BackgroundTaskStatus;
+(function (BackgroundTaskStatus) {
+    /**
+     * Background task scheduling is unavailable or restricted.
+     */
+    BackgroundTaskStatus[BackgroundTaskStatus["Restricted"] = 1] = "Restricted";
+    /**
+     * Background task scheduling is available.
+     */
+    BackgroundTaskStatus[BackgroundTaskStatus["Available"] = 2] = "Available";
+})(BackgroundTaskStatus || (BackgroundTaskStatus = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAN,IAAY,oBAUX;AAVD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,qEAAW,CAAA;IAEX;;OAEG;IACH,mEAAU,CAAA;AACZ,CAAC,EAVW,oBAAoB,KAApB,oBAAoB,QAU/B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,oBAUX;AAVD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,2EAAc,CAAA;IAEd;;OAEG;IACH,yEAAa,CAAA;AACf,CAAC,EAVW,oBAAoB,KAApB,oBAAoB,QAU/B","sourcesContent":["import type { PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Return value for a background task callback.\n */\nexport enum BackgroundTaskResult {\n  /**\n   * The task finished successfully.\n   */\n  Success = 1,\n\n  /**\n   * The task failed.\n   */\n  Failed = 2,\n}\n\n/**\n * Availability status for background task scheduling.\n */\nexport enum BackgroundTaskStatus {\n  /**\n   * Background task scheduling is unavailable or restricted.\n   */\n  Restricted = 1,\n\n  /**\n   * Background task scheduling is available.\n   */\n  Available = 2,\n}\n\n/**\n * Options for registering a periodic background task.\n */\nexport interface BackgroundTaskOptions {\n  /**\n   * Inexact interval in minutes between task runs.\n   *\n   * Defaults to 720 minutes. Android enforces a 15 minute minimum. iOS treats\n   * this as an earliest begin date and may run much later.\n   */\n  minimumInterval?: number;\n\n  /**\n   * Require an active network before running the native scheduler.\n   *\n   * Defaults to true.\n   */\n  requiresNetwork?: boolean;\n}\n\n/**\n * Payload emitted when native scheduling asks JavaScript to run a task.\n */\nexport interface BackgroundTaskEvent {\n  /**\n   * Name passed to registerTaskAsync.\n   */\n  taskName: string;\n\n  /**\n   * Native run identifier. The JavaScript wrapper finishes it automatically\n   * when the defined callback resolves.\n   */\n  taskId: string;\n\n  /**\n   * Native timestamp for the run.\n   */\n  timestamp: number;\n\n  /**\n   * True when triggered through triggerTaskWorkerForTestingAsync.\n   */\n  test?: boolean;\n}\n\n/**\n * Function executed for a background task.\n */\nexport type BackgroundTaskCallback = (\n  event: BackgroundTaskEvent,\n) => Promise<BackgroundTaskResult | void> | BackgroundTaskResult | void;\n\n/**\n * React Native background-task compatible schedule options.\n */\nexport interface ReactNativeBackgroundTaskOptions {\n  /**\n   * Desired seconds between each execution. Mapped to minimumInterval minutes.\n   */\n  period?: number;\n\n  /**\n   * Android-only timeout hint kept for API compatibility.\n   */\n  timeout?: number;\n}\n\n/**\n * React Native background-task compatible status payload.\n */\nexport interface ReactNativeBackgroundTaskStatus {\n  /**\n   * Whether background tasks are available to the app.\n   */\n  available: boolean;\n\n  /**\n   * Reason when unavailable.\n   */\n  unavailableReason?: string;\n}\n\nexport interface GetStatusResult {\n  status: BackgroundTaskStatus;\n}\n\nexport interface BooleanResult {\n  value: boolean;\n}\n\nexport interface PendingTaskRunsResult {\n  tasks: BackgroundTaskEvent[];\n}\n\nexport interface RegisteredTasksResult {\n  tasks: string[];\n}\n\nexport interface FinishOptions {\n  taskId: string;\n  taskName?: string;\n  result?: BackgroundTaskResult;\n}\n\nexport interface RegisterTaskOptions {\n  taskName: string;\n  options?: BackgroundTaskOptions;\n}\n\nexport interface TaskNameOptions {\n  taskName: string;\n}\n\nexport interface NativeBackgroundTaskPlugin {\n  registerTask(options: RegisterTaskOptions): Promise<void>;\n  unregisterTask(options: TaskNameOptions): Promise<void>;\n  isTaskRegistered(options: TaskNameOptions): Promise<BooleanResult>;\n  getRegisteredTasks(): Promise<RegisteredTasksResult>;\n  getPendingTaskRuns(): Promise<PendingTaskRunsResult>;\n  getStatus(): Promise<GetStatusResult>;\n  triggerTaskWorkerForTesting(): Promise<BooleanResult>;\n  finish(options: FinishOptions): Promise<void>;\n  addListener(\n    eventName: 'backgroundTask',\n    listenerFunc: (event: BackgroundTaskEvent) => void,\n  ): Promise<PluginListenerHandle>;\n  addListener(\n    eventName: 'expiration',\n    listenerFunc: (event: BackgroundTaskEvent) => void,\n  ): Promise<PluginListenerHandle>;\n}\n\nexport interface BackgroundTaskPlugin {\n  /**\n   * Define the JavaScript callback for a task. Call this at module/global scope.\n   */\n  defineTask(taskName: string, callback: BackgroundTaskCallback): void;\n\n  /**\n   * Register a named periodic background task.\n   */\n  registerTaskAsync(taskName: string, options?: BackgroundTaskOptions): Promise<void>;\n\n  /**\n   * Unregister a named periodic background task.\n   */\n  unregisterTaskAsync(taskName: string): Promise<void>;\n\n  /**\n   * Check whether a named task is registered.\n   */\n  isTaskRegisteredAsync(taskName: string): Promise<boolean>;\n\n  /**\n   * Return all registered task names.\n   */\n  getRegisteredTasksAsync(): Promise<string[]>;\n\n  /**\n   * Return pending task runs that native recorded before JavaScript was ready.\n   */\n  getPendingTaskRunsAsync(): Promise<BackgroundTaskEvent[]>;\n\n  /**\n   * Return native background task availability.\n   */\n  getStatusAsync(): Promise<BackgroundTaskStatus>;\n\n  /**\n   * Trigger all registered tasks immediately for development/testing.\n   */\n  triggerTaskWorkerForTestingAsync(): Promise<boolean>;\n\n  /**\n   * Listen for iOS expiration callbacks.\n   */\n  addExpirationListener(listener: (event: BackgroundTaskEvent) => void): Promise<PluginListenerHandle>;\n\n  /**\n   * React Native background-task compatible single-task define helper.\n   */\n  define(callback: BackgroundTaskCallback): void;\n\n  /**\n   * React Native background-task compatible single-task scheduler.\n   */\n  schedule(options?: ReactNativeBackgroundTaskOptions): Promise<void>;\n\n  /**\n   * React Native background-task compatible single-task cancel helper.\n   */\n  cancel(): Promise<void>;\n\n  /**\n   * React Native background-task compatible status helper.\n   */\n  statusAsync(): Promise<ReactNativeBackgroundTaskStatus>;\n\n  /**\n   * React Native background-task compatible finish helper. Normal Expo-style\n   * callbacks are finished automatically.\n   */\n  finish(result?: BackgroundTaskResult): Promise<void>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+import type { BackgroundTaskPlugin, NativeBackgroundTaskPlugin } from './definitions';
+declare const NativeBackgroundTask: NativeBackgroundTaskPlugin;
+declare const BackgroundTask: BackgroundTaskPlugin;
+export * from './definitions';
+export { BackgroundTask, NativeBackgroundTask };