Vue d’ensemble

La méthode shouldSetupProject vérifie si un projet doit être configuré avant que des tâches de traduction puissent être mises en file d’attente. Cette méthode interroge l’API pour déterminer si le projet a été correctement initialisé et configuré pour les flux de traduction.

const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const result = await gt.shouldSetupProject();
if (result.shouldSetupProject) {
  console.log('La configuration du projet est requise');
} else {
  console.log('Le projet est prêt pour la traduction');
}

Références

Paramètres

Aucun — cette méthode utilise la configuration de l’instance GT pour vérifier le projet.

Renvoie

Promise<ShouldSetupProjectResult> - Indique, via un booléen, si une configuration est nécessaire.

type ShouldSetupProjectResult = {
  shouldSetupProject: boolean;
}

Exemples

Utilisation de base

import { GT } from 'generaltranslation';

const gt = new GT({
  apiKey: 'your-api-key',
  projectId: 'my-project'
});

async function checkProjectStatus() {
  const result = await gt.shouldSetupProject();
  
  if (result.shouldSetupProject) {
    console.log('Le projet nécessite une configuration');
    return 'setup-required';
  } else {
    console.log('Le projet est prêt pour les traductions');
    return 'ready';
  }
}

const status = await checkProjectStatus();

Notes

• Le résultat détermine si setupProject doit être appelé.
• Les projets nécessitent généralement une configuration lorsqu’ils viennent d’être créés ou lorsqu’ils subissent des modifications structurelles importantes.

Prochaines étapes

• Consultez setupProject pour effectuer la configuration si nécessaire
• Consultez checkSetupStatus pour suivre l’état d’avancement de la configuration
• Consultez enqueueFiles pour lancer les traductions après la configuration
• Consultez uploadSourceFiles pour téléverser les fichiers avant la configuration