Descripción general

El método shouldSetupProject comprueba si un proyecto requiere configuración antes de poder 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('Se requiere configurar el proyecto');
} else {
  console.log('El proyecto está listo para traducciones');
}

Referencias

Parámetros

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

Devuelve

Promise<ShouldSetupProjectResult> - Contiene 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 traducciones');
    return 'listo';
  }
}

const status = await checkProjectStatus();

Notas

• El resultado determina si es necesario invocar setupProject
• Los proyectos normalmente requieren configuración cuando se crean o cuando se realizan cambios estructurales importantes

Próximos pasos

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