Types

DateiZumÜbersetzen

Typdefinition für Dateiobjekte, die bei Batch-Übersetzungen von Dateien verwendet werden

Überblick

FileToTranslate steht für ein Dateiobjekt für Batch-Übersetzungen mit enqueueFiles.

type FileToTranslate = {
  content: string;
  fileName: string;
  fileFormat: FileFormat;
  formatMetadata?: Record<string, any>;
  dataFormat?: DataFormat;
};

Eigenschaften

EigenschaftTypErforderlichBeschreibung
contentstringJaRohdateiinhalt
fileNamestringJaDatei-ID
fileFormatFileFormatJaDateiformat
formatMetadata?Record<string, any>NeinFormatspezifische Metadaten
dataFormat?DataFormatNeinDatenformat innerhalb der Datei

Zugehörige Typen

type FileFormat = 'JSON' | 'MDX' | 'MD' | 'HTML' | 'TXT' | string;
type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';

Beispiele

JSON-Datei

import { FileToTranslate } from 'generaltranslation';

const jsonFile: FileToTranslate = {
  content: JSON.stringify({
    "welcome": "Willkommen",
    "save": "Speichern"
  }),
  fileName: 'common.json',
  fileFormat: 'JSON',
  dataFormat: 'I18NEXT'
};

MDX-Datei

const mdxFile: FileToTranslate = {
  content: `# Erste Schritte\n\nWillkommen auf unserer Plattform!`,
  fileName: 'docs/erste-schritte.mdx',
  fileFormat: 'MDX',
  dataFormat: 'JSX'
};

Verwandte Typen

Wie ist diese Anleitung?