@capawesome/capacitor-background-task/dist/docs.json

Capacitor plugin for running background tasks.

{
  "api": {
    "name": "BackgroundTaskPlugin",
    "slug": "backgroundtaskplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "beforeExit",
        "signature": "(cb: () => void) => Promise<CallbackID>",
        "parameters": [
          {
            "name": "cb",
            "docs": "",
            "type": "() => void"
          }
        ],
        "returns": "Promise<string>",
        "tags": [],
        "docs": "Call this method when the app moves to the background.\nIt allows the app to continue running a task in the background.\n\nOn **iOS** this method should be finished in less than 30 seconds.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "CallbackID"
        ],
        "slug": "beforeexit"
      },
      {
        "name": "finish",
        "signature": "(options: FinishOptions) => void",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "FinishOptions"
          }
        ],
        "returns": "void",
        "tags": [],
        "docs": "Finish the current background task.\nThe OS will put the app to sleep.\n\nOnly available on Android and iOS.",
        "complexTypes": [
          "FinishOptions"
        ],
        "slug": "finish"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "FinishOptions",
      "slug": "finishoptions",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "taskId",
          "tags": [],
          "docs": "",
          "complexTypes": [
            "CallbackID"
          ],
          "type": "CallbackID"
        }
      ]
    }
  ],
  "enums": [],
  "typeAliases": [
    {
      "name": "CallbackID",
      "slug": "callbackid",
      "docs": "",
      "types": [
        {
          "text": "string",
          "complexTypes": []
        }
      ]
    }
  ],
  "pluginConfigs": []
}