capacitor-background-interval-process
Version:
this lib ensures to run the interval process in background when app is suspended
149 lines • 3.42 kB
JSON
{
"api": {
"name": "BackgroundIntervalProcessPlugin",
"slug": "backgroundintervalprocessplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "isProcessAlive",
"signature": "() => Promise<IIsProcessAlive>",
"parameters": [],
"returns": "Promise<IIsProcessAlive>",
"tags": [],
"docs": "",
"complexTypes": [
"IIsProcessAlive"
],
"slug": "isprocessalive"
},
{
"name": "startProcess",
"signature": "(option: IStartOptions) => Promise<void>",
"parameters": [
{
"name": "option",
"docs": "",
"type": "IStartOptions"
}
],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [
"IStartOptions"
],
"slug": "startprocess"
},
{
"name": "terminateProcess",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "terminateprocess"
},
{
"name": "addListener",
"signature": "(eventName: 'DOIT', callback: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle",
"parameters": [
{
"name": "eventName",
"docs": "",
"type": "\"DOIT\""
},
{
"name": "callback",
"docs": "",
"type": "() => void"
}
],
"returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
"tags": [],
"docs": "",
"complexTypes": [
"PluginListenerHandle"
],
"slug": "addlistener"
},
{
"name": "removeAllListeners",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [],
"docs": "",
"complexTypes": [],
"slug": "removealllisteners"
}
],
"properties": []
},
"interfaces": [
{
"name": "IIsProcessAlive",
"slug": "iisprocessalive",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "status",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "IStartOptions",
"slug": "istartoptions",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "interval",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "number"
},
{
"name": "title",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
},
{
"name": "description",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "PluginListenerHandle",
"slug": "pluginlistenerhandle",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "remove",
"tags": [],
"docs": "",
"complexTypes": [],
"type": "() => Promise<void>"
}
]
}
],
"enums": []
}