Présentation

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 workflows 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 nécessaire');
} 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> - Contient un booléen indiquant 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 verifierStatutProjet() {
  const resultat = await gt.shouldSetupProject();
  
  if (resultat.shouldSetupProject) {
    console.log('Le projet doit être configuré');
    return 'setup-required';
  } else {
    console.log('Le projet est prêt pour la traduction');
    return 'ready';
  }
}

const statut = await verifierStatutProjet();

Remarques

• Le résultat détermine s’il est nécessaire d’appeler setupProject
• Les projets nécessitent généralement une configuration lorsqu’ils viennent d’être créés ou lorsque des modifications structurelles importantes sont apportées

Prochaines étapes

• Voir setupProject pour effectuer la configuration si nécessaire
• Voir checkSetupStatus pour suivre l’avancement de la configuration
• Voir enqueueFiles pour lancer les traductions après la configuration
• Voir uploadSourceFiles pour téléverser des files avant la configuration