Types

EnqueueFilesOptions

Configuration options for batch file translation operations

Overview

EnqueueFilesOptions configures batch file translation operations.

type EnqueueFilesOptions = {
  publish?: boolean;
  requireApproval?: boolean;
  description?: string;
  sourceLocale?: string;
  targetLocales: string[];
  version?: string;
  _versionId?: string;
  timeout?: number;
  modelProvider?: string;
  force?: boolean;
};

Properties

PropertyTypeRequiredDescription
publish?booleanNoAuto-publish translations
requireApproval?booleanNoRequire approval workflow
sourceLocale?stringNoSource locale override
targetLocalesstring[]YesTarget locale codes
version?stringNoVersion identifier
timeout?numberNoRequest timeout (ms)
modelProvider?stringNoTranslation model provider
force?booleanNoForce reprocessing

Examples

Basic Usage

import { GT, EnqueueFilesOptions } from 'generaltranslation';

const options: EnqueueFilesOptions = {
  targetLocales: ['es', 'fr', 'de'],
  publish: false,
  requireApproval: true
};

const result = await gt.enqueueFiles(files, options);

Development vs Production

// Development
const devOptions: EnqueueFilesOptions = {
  targetLocales: ['es'],
  publish: true,
  requireApproval: false
};

// Production  
const prodOptions: EnqueueFilesOptions = {
  targetLocales: ['es', 'fr', 'de', 'ja'],
  publish: false,
  requireApproval: true,
  modelProvider: 'premium'
};

How is this guide?

EnqueueFilesOptions