Descripción general

El método shouldSetupProject comprueba si un proyecto requiere configuración antes de que se puedan encolar trabajos de traducción. Este método consulta la API para determinar si el proyecto se ha inicializado y configurado correctamente para los flujos de trabajo de traducción.

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

const result = await gt.shouldSetupProject();
if (result.shouldSetupProject) {
  console.log('Es necesario configurar el proyecto');
} else {
  console.log('El proyecto está listo para las traducciones');
}

Referencias

Parámetros

Ninguno: este método utiliza la configuración de la instancia de GT para verificar el proyecto.

Devuelve

Promise<ShouldSetupProjectResult> - Incluye un valor booleano que indica si es necesario realizar la configuración.

type ShouldSetupProjectResult = {
  shouldSetupProject: boolean;
}

Ejemplos

Uso básico

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('El proyecto necesita configuración');
    return 'configuración-requerida';
  } else {
    console.log('El proyecto está listo para las traducciones');
    return 'listo';
  }
}

const status = await checkProjectStatus();

Notas

• El resultado determina si es necesario llamar a setupProject
• Los proyectos suelen requerir configuración cuando se acaban de crear o cuando se realizan cambios estructurales significativos

Próximos pasos

• Consulta setupProject para realizar la configuración si es necesario
• Consulta checkSetupStatus para supervisar el progreso de la configuración
• Consulta enqueueFiles para iniciar las traducciones después de la configuración
• Consulta uploadSourceFiles para subir files antes de la configuración