仪表板
GT ClassMethodsTranslation

shouldSetupProject

shouldSetupProject 方法的 API 参考：用于检查是否需要进行项目设置

概述

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;
}
属性类型描述
shouldSetupProjectboolean需要进行项目设置时为 true，已完成设置时为 false

示例

基本用法

index.ts
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('项目需要配置');
    return 'setup-required';
  } else {
    console.log('项目已准备就绪，可以开始翻译');
    return 'ready';
  }
}

const status = await checkProjectStatus();

说明

  • 该结果决定是否需要调用 setupProject
  • 项目通常在新建或进行重大结构变更时需要进行设置

后续步骤

这份指南怎么样？

setupProject

setupProject 方法的 API 参考：用于初始化翻译项目的设置

translate

GT translate 方法的 API 参考

本页内容

概述
参考
参数
返回值
示例
基本用法
说明
后续步骤
shouldSetupProject