shouldSetupProject
Riferimento API per il metodo shouldSetupProject che verifica se è necessaria la configurazione del progetto
Panoramica
Il metodo shouldSetupProject verifica se un progetto necessita di configurazione prima che i job di traduzione possano essere messi in coda.
Questo metodo interroga l’API per stabilire se il progetto è stato correttamente inizializzato e configurato per i flussi di lavoro di traduzione.
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });
const result = await gt.shouldSetupProject();
if (result.shouldSetupProject) {
console.log('È necessario configurare il progetto');
} else {
console.log('Il progetto è pronto per le traduzioni');
}Riferimenti
Parametri
Nessuno: questo metodo usa la configurazione dell’istanza di GT per verificare il progetto.
Restituisce
Promise<ShouldSetupProjectResult> - Contiene un valore booleano che indica se è necessario eseguire la configurazione.
type ShouldSetupProjectResult = {
shouldSetupProject: boolean;
}| Proprietà | Tipo | Descrizione |
|---|---|---|
shouldSetupProject | boolean | true se è necessario configurare il progetto, false se è già stato configurato |
Esempi
Uso di base
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('Il progetto richiede la configurazione');
return 'setup-required';
} else {
console.log('Il progetto è pronto per le traduzioni');
return 'ready';
}
}
const status = await checkProjectStatus();Note
- Il risultato determina se è necessario chiamare
setupProject - In genere i progetti richiedono una configurazione quando vengono creati ex novo o quando vengono apportate modifiche strutturali significative
Prossimi passaggi
- Consulta
setupProjectper eseguire la configurazione, se necessario - Consulta
checkSetupStatusper monitorare l’avanzamento della configurazione - Consulta
enqueueFilesper avviare le traduzioni dopo la configurazione - Consulta
uploadSourceFilesper caricare i file prima della configurazione
Come valuti questa guida?