Dashboard
GT ClassMethodsTranslation

shouldSetupProject

API Reference for the shouldSetupProject method to check if project setup is required

Overview

The shouldSetupProject method checks whether a project requires setup before translation jobs can be enqueued. This method queries the API to determine if the project has been properly initialized and configured for translation workflows.

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

const result = await gt.shouldSetupProject();
if (result.shouldSetupProject) {
  console.log('Project setup is required');
} else {
  console.log('Project is ready for translations');
}

Reference

Parameters

None - this method uses the GT instance configuration to check the project.

Returns

Promise<ShouldSetupProjectResult> - Contains a boolean indicating if setup is required.

type ShouldSetupProjectResult = {
  shouldSetupProject: boolean;
}
PropertyTypeDescription
shouldSetupProjectbooleantrue if project setup is required, false if already set up

Examples

Basic Usage

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('Project needs setup');
    return 'setup-required';
  } else {
    console.log('Project is ready for translations');
    return 'ready';
  }
}

const status = await checkProjectStatus();

Notes

  • The result determines whether setupProject needs to be called
  • Projects typically need setup when they're newly created or when significant structural changes are made

Next Steps

How is this guide?

setupProject

API Reference for the setupProject method to initialize translation project setup

translate

API Reference for the GT translate method

On this page

Overview
Reference
Parameters
Returns
Examples
Basic Usage
Notes
Next Steps
shouldSetupProject