Tâche

11 min

Création d'une tâche

Fonction permettant de programmer l'exécution d'une opération asynchrone.

Signature

export const scheduleTask: (args: {
  taskName: string;
  scheduledAt?: Date;
  metadata?: object
}) => Promise<void>;

Exemple

import { scheduleTask } from '@fasstech/oip-core/tasks';

await scheduleTask({ taskName: 'mytask', metadata: { foo: 'bar' } });

Si aucune valeur n'est spécifiée pour la propriété scheduledAt, alors la tâche est programmée pour une exécution immédiate.

Gestion des erreurs

Si le service OIP Headless envoie une réponse avec un statut dont la valeur est égale à 401 ou supérieure ou égale à 422, alors une erreur sera levée.

Création d'un workflow de tâches

Fonction permettant de programmer l'exécution d'un ensemble ordonnée d'opérations asynchrones.

Signature

export const scheduleTasks: (args: {
  workflowName: string;
  scheduledAt?: Date;
  metadata?: object
}) => Promise<void>;

Exemple

import { scheduleTask } from '@fasstech/oip-core/tasks';

await scheduleTasks({ workflowName: 'myworkflow', metadata: { foo: 'bar' } });

Si aucune valeur n'est spécifiée pour la propriété scheduledAt, alors la tâche est programmée pour une exécution immédiate.

Gestion des erreurs

Si le service OIP Headless envoie une réponse avec un statut dont la valeur est égale à 401 ou supérieure ou égale à 422, alors une erreur sera levée.

Récupération d'une tâche

Fonction permettant de récupérer les informations associées à une tâche.

Signature

export const getTask: (args: {
  taskName: string;
  metadata?: object;
}) => Promise<{ taskId: string; state: string; metadata?: object } | null>;

Exemple

import { getTask } from '@fasstech/oip-core/tasks';

await getTask({ taskName: 'mytask' });

Gestion des erreurs

Si le service OIP Headless envoie une réponse avec un statut dont la valeur est égale à 401 ou supérieure ou égale à 422, alors une erreur sera levée.