kuito.
Commencer

BackgroundTaskOptions

Tells the OS how often a background task may run and what the device must have (a network, a charger) before it does.

type

Utilisation

Skip work when a background run has no time left.

Ce type est utilisé par backgroundTasks.schedule

tsx
// 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.

Déclaration du type

ts
export type BackgroundTaskOptions = {
  /** Minutes between runs, at least 15 (Android's floor). The OS may wait longer. Defaults to 15. */
  minimumInterval?: number;
  /** Run only with a network connection. */
  requiresNetwork?: boolean;
  /** Run only while charging. On iOS this makes it a processing task (docs/background-tasks.md). */
  requiresCharging?: boolean;
};

Membres 3

NomTypeRequisDescription
minimumIntervalnumberNonMinutes between runs, at least 15 (Android's floor). The OS may wait longer. Defaults to 15.
requiresNetworkbooleanNonRun only with a network connection.
requiresChargingbooleanNonRun only while charging. On iOS this makes it a processing task (docs/background-tasks.md).
Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.