getProjectData
Référence de l’API pour la méthode getProjectData permettant de récupérer les informations et la configuration du projet
Vue d’ensemble
La méthode getProjectData récupère des informations détaillées sur un projet de traduction, notamment son nom, son organisation, sa locale par défaut et les locales cibles actuellement configurées.
Cette méthode est utile pour comprendre la configuration du projet et valider ses paramètres.
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });
const projectData = await gt.getProjectData('project-123');
console.log(`Projet : ${projectData.name}`);
console.log(`Locale par défaut : ${projectData.defaultLocale}`);
console.log(`Locales cibles : ${projectData.currentLocales.join(', ')}`);Références
Paramètres
| Nom | Type | Description |
|---|---|---|
projectId | string | L’identifiant unique du projet à récupérer |
options? | { timeout?: number } | Configuration facultative de la requête |
Options
| Nom | Type | Description |
|---|---|---|
timeout? | number | Délai d’attente de la requête, en millisecondes |
Renvoie
Promise<ProjectData> - Contient les informations et la configuration du projet.
type ProjectData = {
id: string;
name: string;
orgId: string;
defaultLocale: string;
currentLocales: string[];
}| Propriété | Type | Description |
|---|---|---|
id | string | Identifiant unique du projet |
name | string | Nom de projet lisible par l’humain |
orgId | string | Identifiant de l’organisation propriétaire du projet |
defaultLocale | string | Locale source par défaut du projet |
currentLocales | string[] | Tableau des locales cibles actuellement configurées |
Exemples
Utilisation de base
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('=== Informations du projet ===');
console.log(`ID : ${project.id}`);
console.log(`Nom : ${project.name}`);
console.log(`Organisation : ${project.orgId}`);
console.log(`Locale par défaut : ${project.defaultLocale}`);
console.log(`Locales cibles : ${project.currentLocales.join(', ')}`);
return project;
} catch (error) {
console.error(`Impossible de récupérer le projet ${projectId} :`, error);
throw error;
}
}
const projectInfo = await getProjectInfo('my-project-123');Notes
- La méthode offre un accès en lecture seule aux informations du projet — utilisez le tableau de bord pour modifier les paramètres du projet
- Cette méthode nécessite un ID de projet valide — le projet doit être accessible avec la clé d’API fournie
- Les données du projet incluent les configurations de locales source et cibles
- Le tableau
currentLocalesrépertorie toutes les locales cibles configurées pour le projet - Utilisez cette méthode pour valider la configuration du projet avant de lancer les workflows de traduction
Prochaines étapes
- Consultez
shouldSetupProjectpour vérifier si une configuration du projet est nécessaire - Consultez
setupProjectpour initialiser la configuration du projet - Consultez
enqueueFilespour lancer les tâches de traduction - Consultez
querySourceFilepour obtenir des informations spécifiques au fichier
Comment trouvez-vous ce guide ?