GT ClassMethodsTranslation

getProjectData

Referencia de API del método getProjectData para obtener la información y la configuración del proyecto

Descripción general

El método getProjectData recupera información detallada sobre un proyecto de traducción, incluyendo su name, organización, locale predeterminada y las locales de destino actualmente configuradas. Este método resulta útil para comprender la configuración del proyecto y validar su configuración.

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

const projectData = await gt.getProjectData('project-123');
console.log(`Proyecto: ${projectData.name}`);
console.log(`Locale por defecto: ${projectData.defaultLocale}`);
console.log(`Locales de destino: ${projectData.currentLocales.join(', ')}`);

Referencias

Parámetros

NombreTipoDescripción
projectIdstringIdentificador único del proyecto que se debe recuperar
options?{ timeout?: number }Configuración opcional de la solicitud

Opciones

NombreTipoDescripción
timeout?numberTiempo de espera de la solicitud en milisegundos

Devuelve

Promise<ProjectData> - Contiene la información y la configuración del proyecto.

type ProjectData = {
  id: string;
  name: string;
  orgId: string;
  defaultLocale: string;
  currentLocales: string[];
}
PropiedadTipoDescripción
idstringIdentificador único del proyecto
namestringNombre del proyecto en un formato legible
orgIdstringIdentificador de la organización propietaria del proyecto
defaultLocalestringlocale de origen predeterminado del proyecto
currentLocalesstring[]Arreglo de locales de destino actualmente configurados

Ejemplos

Uso básico

index.ts
import { GT } from 'generaltranslation';

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

async function getProjectInfo(projectId: string) {
  try {
    const project = await gt.getProjectData(projectId);
    
    console.log('=== Información del proyecto ===');
    console.log(`ID: ${project.id}`);
    console.log(`Nombre: ${project.name}`);
    console.log(`Organización: ${project.orgId}`);
    console.log(`Locale predeterminado: ${project.defaultLocale}`);
    console.log(`Locales de destino: ${project.currentLocales.join(', ')}`);
    
    return project;
  } catch (error) {
    console.error(`No se pudo obtener el proyecto ${projectId}:`, error);
    throw error;
  }
}

const projectInfo = await getProjectInfo('my-project-123');

Notas

  • El método ofrece acceso de solo lectura a la información del proyecto; usa el dashboard para modificar la configuración del proyecto
  • Este método requiere un id de proyecto válido; el proyecto debe ser accesible con la clave de API proporcionada
  • Los datos del proyecto incluyen las configuraciones de locale tanto de origen como de destino
  • El array currentLocales representa todas las locales de destino configuradas para el proyecto
  • Usa este método para validar la configuración del proyecto antes de iniciar los flujos de trabajo de traducción

Próximos pasos

  • Consulta shouldSetupProject para comprobar si es necesaria la configuración del proyecto
  • Consulta setupProject para iniciar la configuración del proyecto
  • Consulta enqueueFiles para iniciar trabajos de traducción
  • Consulta querySourceFile para obtener información específica del archivo

¿Qué te ha parecido esta guía?

getProjectData