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;
}| プロパティ | 型 | 説明 |
|---|---|---|
shouldSetupProject | boolean | プロジェクトのセットアップが必要なら true、すでに完了しているなら false |
例
基本的な使用方法
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を参照してください - セットアップの進行状況を確認するには
checkSetupStatusを参照してください - セットアップ後に翻訳を開始するには
enqueueFilesを参照してください - セットアップ前にソースファイルをアップロードするには
uploadSourceFilesを参照してください
このガイドはどうでしたか？