GT ClassMethodsTranslation
shouldSetupProject
Справочник API по методу shouldSetupProject для проверки, требуется ли настройка проекта
Обзор
Метод shouldSetupProject проверяет, нужна ли настройка проекта перед постановкой заданий перевода в очередь.
Этот метод обращается к API, чтобы определить, был ли проект корректно инициализирован и настроен для рабочих процессов перевода.
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });
const result = await gt.shouldSetupProject();
if (result.shouldSetupProject) {
console.log('Требуется настройка проекта');
} else {
console.log('Проект готов к переводу');
}Справка
Параметры
Нет — этот метод использует конфигурацию экземпляра GT для проверки проекта.
Возвращает
Promise<ShouldSetupProjectResult> — содержит логическое значение, указывающее, требуется ли настройка.
type ShouldSetupProjectResult = {
shouldSetupProject: boolean;
}| Свойство | Тип | Описание |
|---|---|---|
shouldSetupProject | boolean | true, если требуется настройка проекта; false, если он уже настроен |
Примеры
Базовое применение
import { GT } from 'generaltranslation';
const gt = new GT({
apiKey: 'ваш ключ API',
projectId: 'my-project'
});
async function checkProjectStatus() {
const result = await gt.shouldSetupProject();
if (result.shouldSetupProject) {
console.log('Необходимо настроить проект');
return 'setup-required';
} else {
console.log('Проект готов к переводам');
return 'ready';
}
}
const status = await checkProjectStatus();Примечания
- Результат определяет, нужно ли вызывать
setupProject - Проекты обычно требуют первичной настройки при создании или после внесения существенных структурных изменений
Дальнейшие шаги
- См.
setupProject, чтобы при необходимости выполнить настройку - См.
checkSetupStatus, чтобы отслеживать прогресс настройки - См.
enqueueFiles, чтобы начать перевод после настройки - См.
uploadSourceFiles, чтобы загрузить файлы до настройки
Насколько полезно это руководство?