backgroundTasks.BackgroundTaskRun
What a task receives when the OS runs it.
Utilização
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.Declaração do tipo
export type BackgroundTaskRun = {
name: string;
/** When the OS stops the run, in milliseconds since the epoch. Finish before it. */
deadline: number;
};Membros 2
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | Sim | — |
deadline | number | Sim | When the OS stops the run, in milliseconds since the epoch. Finish before it. |
Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.