backgroundTasks.schedule
Asks the OS to run the task about every minimumInterval minutes, across restarts.
Usage
Skip work when a background run has no time left.
// Skip work when a background run has no time left.
import { backgroundTasks, type BackgroundTaskRun, type BackgroundTaskStatus } from 'kuito';
backgroundTasks.define('refresh', async (run: BackgroundTaskRun) => {
if (run.deadline - Date.now() < 5000) return;
const response = await fetch('https://example.com/feed', { signal: AbortSignal.timeout(4000) });
if (!response.ok) throw new Error(`Refresh failed: ${response.status}`);
});
export async function enableRefresh() {
const status: BackgroundTaskStatus = await backgroundTasks.status();
if (status === 'available') await backgroundTasks.schedule('refresh');
}
// Declare refresh in kuito.config.ts before rebuilding the native app.Signatures
(name: string, options?: BackgroundTaskOptions): Promise<void>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
options | BackgroundTaskOptions | No | — Default: {} |
Returns
Promise<void>
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.