Types

FileDaTradurre

Definizione del tipo per gli oggetti file usati nelle operazioni di traduzione di file in batch

Panoramica

FileToTranslate rappresenta un oggetto file per operazioni di traduzione batch con enqueueFiles.

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

Proprietà

ProprietàTipoObbligatorioDescrizione
contentstringContenuto del file in forma grezza
fileNamestringIdentificatore del file
fileFormatFileFormatFormato del file
formatMetadata?Record<string, any>NoMetadati specifici del formato
dataFormat?DataFormatNoFormato dei dati all'interno del file

Tipi correlati

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

Esempi

File JSON

import { FileToTranslate } from 'generaltranslation';

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

File MDX

const mdxFile: FileToTranslate = {
  content: `# Primi passi\n\nBenvenuto sulla nostra piattaforma!`,
  fileName: 'docs/start.mdx',
  fileFormat: 'MDX',
  dataFormat: 'JSX'
};

Tipi correlati

Come valuti questa guida?

FileDaTradurre