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 completa sobre un proyecto de traducción, incluidos su name, organización, locale predeterminado y las locales de destino configuradas actualmente.
Este método es útil para comprender la configuración del proyecto y validar la configuración del proyecto.
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 predeterminada: ${projectData.defaultLocale}`);
console.log(`Locales de destino: ${projectData.currentLocales.join(', ')}`);Referencias
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
projectId | string | Identificador único del proyecto que se va a obtener |
options? | { timeout?: number } | Configuración opcional de la solicitud |
Opciones
| Nombre | Tipo | Descripción |
|---|---|---|
timeout? | number | Tiempo de espera de la petición en milisegundos |
Devolución
Promise<ProjectData> - Contiene la información y la configuración del proyecto.
type ProjectData = {
id: string;
name: string;
orgId: string;
defaultLocale: string;
currentLocales: string[];
}| Propiedad | Tipo | Descripción |
|---|---|---|
id | string | Identificador único del proyecto |
name | string | Nombre del proyecto legible para humanos |
orgId | string | Identificador de la organización propietaria del proyecto |
defaultLocale | string | Locale de origen predeterminado del proyecto |
currentLocales | string[] | Matriz de locales de destino actualmente configurados |
Ejemplos
Uso básico
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 recuperar el proyecto ${projectId}:`, error);
throw error;
}
}
const projectInfo = await getProjectInfo('my-project-123');Notas
- El método proporciona acceso de solo lectura a la información del proyecto; utiliza 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 para origen y destino
- El array
currentLocalesrepresenta todos los locales de destino configurados para el proyecto - Utiliza este método para validar la configuración del proyecto antes de iniciar los flujos de trabajo de traducción
Próximos pasos
- Consulta
shouldSetupProjectpara comprobar si es necesario configurar el proyecto - Consulta
setupProjectpara iniciar la configuración del proyecto - Consulta
enqueueFilespara iniciar tareas de traducción - Consulta
querySourceFilepara obtener información específica del archivo
¿Qué te parece esta guía?