setupProject

Overview

The setupProject method initializes the setup process for a translation project using previously uploaded files. This creates an asynchronous setup job that analyzes the files and prepares them for translation workflows.

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

const setupResult = await gt.setupProject(fileRefs, { timeout: 30000 });
console.log(`Setup job created: ${setupResult.jobId}`);

You must have previously uploaded the files using uploadSourceFiles before calling setupProject.

Reference

Parameters

Name	Type	Description
`files`	`FileReference[]`	Array of file references from previously uploaded source files
`options?`	`SetupProjectOptions`	Optional settings for the setup job

FileReference Structure

type FileReference = {
  fileId: string;
  versionId: string;
  branchId: string;
  fileName: string;
  fileFormat?: FileFormat;
  dataFormat?: DataFormat;
}

SetupProjectOptions

Name	Type	Description
`locales?`	`string[]`	Optional array of target locales
`timeout?`	`number`	Optional timeout in milliseconds for the API request

Returns

Promise<SetupProjectResult> - Contains the setup job identifier and initial status.

type SetupProjectResult = {
  jobId: string;
  status: 'queued';
}

Property	Type	Description
`jobId`	`string`	Unique identifier for the setup job
`status`	`'queued'`	Initial status of the setup job

Examples

Basic usage

Initialize project setup with uploaded files:

index.ts

import { GT } from 'generaltranslation';

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

// File references from previous upload
const fileRefs = [
  {
    fileId: 'file-123',
    versionId: 'version-456',
    branchId: 'branch-789',
    fileName: 'app.json',
    fileFormat: 'JSON'
  },
  {
    fileId: 'file-789',
    versionId: 'version-012',
    branchId: 'branch-789',
    fileName: 'content.md',
    fileFormat: 'MD'
  }
];

const setupResult = await gt.setupProject(fileRefs);
console.log(`Setup initiated with job ID: ${setupResult.jobId}`);

// Monitor job status
const jobStatus = await gt.checkJobStatus([setupResult.jobId]);
console.log(`Job status: ${jobStatus.jobs[0].status}`);

Notes

Files must be uploaded using uploadSourceFiles before calling setupProject
Project setup analyzes file content and structure to optimize translation workflows
The setup job runs asynchronously - monitor progress with checkJobStatus
Setup is typically required before enqueueing translation jobs for new projects
File references include branchId for proper versioning with branching support

Next steps

See uploadSourceFiles to upload files before setup
See checkJobStatus to monitor setup progress
See enqueueFiles to start translations after setup

Overview

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

const setupResult = await gt.setupProject(fileRefs, { timeout: 30000 });
console.log(`Setup job created: ${setupResult.jobId}`);

You must have previously uploaded the files using uploadSourceFiles before calling setupProject.

Reference

Parameters

Name	Type	Description
`files`	`FileReference[]`	Array of file references from previously uploaded source files
`options?`	`SetupProjectOptions`	Optional settings for the setup job

FileReference Structure

type FileReference = {
  fileId: string;
  versionId: string;
  branchId: string;
  fileName: string;
  fileFormat?: FileFormat;
  dataFormat?: DataFormat;
}

SetupProjectOptions

Name	Type	Description
`locales?`	`string[]`	Optional array of target locales
`timeout?`	`number`	Optional timeout in milliseconds for the API request

Returns

Promise<SetupProjectResult> - Contains the setup job identifier and initial status.

type SetupProjectResult = {
  jobId: string;
  status: 'queued';
}

Property	Type	Description
`jobId`	`string`	Unique identifier for the setup job
`status`	`'queued'`	Initial status of the setup job

Examples

Basic usage

Initialize project setup with uploaded files:

index.ts

import { GT } from 'generaltranslation';

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

// File references from previous upload
const fileRefs = [
  {
    fileId: 'file-123',
    versionId: 'version-456',
    branchId: 'branch-789',
    fileName: 'app.json',
    fileFormat: 'JSON'
  },
  {
    fileId: 'file-789',
    versionId: 'version-012',
    branchId: 'branch-789',
    fileName: 'content.md',
    fileFormat: 'MD'
  }
];

const setupResult = await gt.setupProject(fileRefs);
console.log(`Setup initiated with job ID: ${setupResult.jobId}`);

// Monitor job status
const jobStatus = await gt.checkJobStatus([setupResult.jobId]);
console.log(`Job status: ${jobStatus.jobs[0].status}`);

Notes

Files must be uploaded using uploadSourceFiles before calling setupProject
Project setup analyzes file content and structure to optimize translation workflows
The setup job runs asynchronously - monitor progress with checkJobStatus
Setup is typically required before enqueueing translation jobs for new projects
File references include branchId for proper versioning with branching support

Next steps

See uploadSourceFiles to upload files before setup
See checkJobStatus to monitor setup progress
See enqueueFiles to start translations after setup

Overview

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

const setupResult = await gt.setupProject(fileRefs, { timeout: 30000 });
console.log(`Setup job created: ${setupResult.jobId}`);

You must have previously uploaded the files using uploadSourceFiles before calling setupProject.

Reference

Parameters

Name	Type	Description
`files`	`FileReference[]`	Array of file references from previously uploaded source files
`options?`	`SetupProjectOptions`	Optional settings for the setup job

FileReference Structure

type FileReference = {
  fileId: string;
  versionId: string;
  branchId: string;
  fileName: string;
  fileFormat?: FileFormat;
  dataFormat?: DataFormat;
}

SetupProjectOptions

Name	Type	Description
`locales?`	`string[]`	Optional array of target locales
`timeout?`	`number`	Optional timeout in milliseconds for the API request

Returns

Promise<SetupProjectResult> - Contains the setup job identifier and initial status.

type SetupProjectResult = {
  jobId: string;
  status: 'queued';
}

Property	Type	Description
`jobId`	`string`	Unique identifier for the setup job
`status`	`'queued'`	Initial status of the setup job

Examples

Basic usage

Initialize project setup with uploaded files:

index.ts

import { GT } from 'generaltranslation';

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

// File references from previous upload
const fileRefs = [
  {
    fileId: 'file-123',
    versionId: 'version-456',
    branchId: 'branch-789',
    fileName: 'app.json',
    fileFormat: 'JSON'
  },
  {
    fileId: 'file-789',
    versionId: 'version-012',
    branchId: 'branch-789',
    fileName: 'content.md',
    fileFormat: 'MD'
  }
];

const setupResult = await gt.setupProject(fileRefs);
console.log(`Setup initiated with job ID: ${setupResult.jobId}`);

// Monitor job status
const jobStatus = await gt.checkJobStatus([setupResult.jobId]);
console.log(`Job status: ${jobStatus.jobs[0].status}`);

Notes

Files must be uploaded using uploadSourceFiles before calling setupProject
Project setup analyzes file content and structure to optimize translation workflows
The setup job runs asynchronously - monitor progress with checkJobStatus
Setup is typically required before enqueueing translation jobs for new projects
File references include branchId for proper versioning with branching support

Next steps

See uploadSourceFiles to upload files before setup
See checkJobStatus to monitor setup progress
See enqueueFiles to start translations after setup

setupProject

Overview

Reference

Parameters

FileReference Structure

SetupProjectOptions

Returns

Examples

Basic usage

Notes

Next steps

On this page

setupProject

Overview

Reference

Parameters

FileReference Structure

SetupProjectOptions

Returns

Examples

Basic usage

Notes

Next steps

On this page

setupProject

Overview

Reference

Parameters

FileReference Structure

SetupProjectOptions

Returns

Examples

Basic usage

Notes

Next steps

On this page