Types
FichierÀTraduire
Définition de type pour les objets fichier utilisés dans les opérations de traduction de fichiers par lots
Aperçu
FileToTranslate représente un objet fichier pour des opérations de traduction par lots avec enqueueFiles.
type FileToTranslate = {
content: string;
fileName: string;
fileFormat: FileFormat;
formatMetadata?: Record<string, any>;
dataFormat?: DataFormat;
};Propriétés
| Propriété | Type | Obligatoire | Description |
|---|---|---|---|
content | string | Oui | Contenu brut du fichier |
fileName | string | Oui | Identifiant du fichier |
fileFormat | FileFormat | Oui | Format du fichier |
formatMetadata? | Record<string, any> | Non | Métadonnées propres au format |
dataFormat? | DataFormat | Non | Format des données dans le fichier |
Types connexes
type FileFormat = 'JSON' | 'MDX' | 'MD' | 'HTML' | 'TXT' | string;
type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';Exemples
Fichier JSON
import { FileToTranslate } from 'generaltranslation';
const jsonFile: FileToTranslate = {
content: JSON.stringify({
"welcome": "Bienvenue",
"save": "Enregistrer"
}),
fileName: 'common.json',
fileFormat: 'JSON',
dataFormat: 'I18NEXT'
};Fichier MDX
const mdxFile: FileToTranslate = {
content: `# Premiers pas\n\nBienvenue sur notre plateforme !`,
fileName: 'docs/start.mdx',
fileFormat: 'MDX',
dataFormat: 'JSX'
};Types associés
EnqueueFilesOptions- Options de traitement en lot
Comment trouvez-vous ce guide ?