Übersicht

Die Methode shouldSetupProject prüft, ob ein Projekt eingerichtet werden muss, bevor Übersetzungsaufträge in die Warteschlange gestellt werden können. Diese Methode fragt die API ab, um festzustellen, ob das Projekt ordnungsgemäß initialisiert und für Übersetzungs-Workflows konfiguriert wurde.

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

const result = await gt.shouldSetupProject();
if (result.shouldSetupProject) {
  console.log('Projekteinrichtung erforderlich');
} else {
  console.log('Projekt ist für Übersetzungen bereit');
}

Referenz

Parameter

Keine – diese Methode verwendet die GT-Instanzkonfiguration, um das Projekt zu überprüfen.

Rückgabewert

Promise<ShouldSetupProjectResult> – Enthält einen booleschen Wert, der angibt, ob eine Einrichtung erforderlich ist.

type ShouldSetupProjectResult = {
  shouldSetupProject: boolean;
}

Beispiele

Grundlegende Nutzung

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('Projekt muss eingerichtet werden');
    return 'einrichtung-erforderlich';
  } else {
    console.log('Projekt ist bereit für Übersetzungen');
    return 'bereit';
  }
}

const status = await checkProjectStatus();

Hinweise

• Das Ergebnis bestimmt, ob setupProject aufgerufen werden muss
• Projekte müssen in der Regel eingerichtet werden, wenn sie neu erstellt wurden oder wenn wesentliche strukturelle Änderungen vorgenommen wurden

Nächste Schritte

• Siehe setupProject, um bei Bedarf die Einrichtung durchzuführen
• Siehe checkSetupStatus, um den Fortschritt der Einrichtung zu überwachen
• Siehe enqueueFiles, um nach der Einrichtung Übersetzungen zu starten
• Siehe uploadSourceFiles, um Dateien vor der Einrichtung hochzuladen