ez-localize/lib/utils.d.ts

Super-simple localization of strings in a Node/Browserify application

import { LocalizerData } from ".";
export interface LocalizedString {
    _base: string;
    [language: string]: string;
}
export interface Locale {
    /** ISO code for locale (e.g. "en") */
    code: string;
    /** Local name for locale (e.g. Espanol) */
    name: string;
}
/** Extracts localized strings from a plain object */
export declare function extractLocalizedStrings(obj: any): LocalizedString[];
/** Keep unique base language string combinations */
export declare function dedupLocalizedStrings(strs: LocalizedString[]): LocalizedString[];
/** Change the base locale for a set of localizations.
 * Works by making whatever the user sees as the toLocale base
 */
export declare function changeBaseLocale(strs: LocalizedString[], fromLocale: string, toLocale: string): void;
/** Update a set of strings based on newly localized ones. Mutates the original strings. Optionally specify a locale to update. */
export declare function updateLocalizedStrings(strs: LocalizedString[], updates: LocalizedString[], locale?: string): void;
/** Exports localized strings for specified locales to XLSX file. Returns base64 */
export declare function exportXlsx(locales: Locale[], strs: LocalizedString[]): string;
/** Import from base64 excel */
export declare function importXlsx(locales: Locale[], xlsxFile: string): LocalizedString[];
/** Remove unused strings from a LocalizerData object */
export declare function removeUnusedStrings(data: LocalizerData): LocalizerData;
/** Merge multiple LocalizerData objects. Merges locales and strings, then determines unused strings by
 * union of all unused strings from inputs then removing any strings that are actually used.
 * Prefers translations from later inputs over earlier ones. */
export declare function mergeLocalizerData(inputs: LocalizerData[]): LocalizerData;