Types

ArchivoParaTraducir

Definición de tipos para objetos de archivo usados en operaciones de traducción de archivos por lotes

Descripción general

FileToTranslate representa un objeto de archivo para operaciones de traducción en lote con enqueueFiles.

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

Propiedades

PropiedadTipoRequeridoDescripción
contentstringContenido bruto del archivo
fileNamestringIdentificador del archivo
fileFormatFileFormatFormato de archivo
formatMetadata?Record<string, any>NoMetadatos específicos del formato
dataFormat?DataFormatNoFormato de datos dentro del archivo

Tipos relacionados

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

Ejemplos

Archivo JSON

import { FileToTranslate } from 'generaltranslation';

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

Archivo MDX

const mdxFile: FileToTranslate = {
  content: `# Primeros pasos\n\n¡Bienvenido a nuestra plataforma!`,
  fileName: 'docs/start.mdx',
  fileFormat: 'MDX',
  dataFormat: 'JSX'
};

Tipos relacionados

¿Qué te ha parecido esta guía?

ArchivoParaTraducir