gedcom-ts
Version:
TypeScript GEDCOM toolkit for browser apps: import .ged/.zip, edit typed genealogy data, and export GEDCOM or GEDZIP.
21 lines (20 loc) • 1.28 kB
TypeScript
import { ReadGed } from './ReadGed';
import type { Place } from '../commons/Place';
import { type GedcomTransferProgressCallback } from "../utils/gedcom/transferProgress";
/**
* Erreur levée quand une entrée `.ged` dans un ZIP ne se décode pas comme du GEDCOM valide
* (en-tête `0 HEAD` absent au début). Cause la plus fréquente : **ZIP chiffré** (mot de passe),
* non pris en charge par le décompresseur utilisé ici.
*
* Les applications peuvent comparer `error.message === IMPORT_ERR_ZIP_GED_UNREADABLE`.
*/
export declare const IMPORT_ERR_ZIP_GED_UNREADABLE = "ZIP chiffr\u00E9 (mot de passe) ou .ged illisible dans l\u2019archive : extrayez le fichier .ged avec votre explorateur ou utilitaire ZIP, puis importez uniquement ce .ged. L\u2019import direct des archives prot\u00E9g\u00E9es par mot de passe n\u2019est pas pris en charge.";
/** Same as {@link ReadGed.empty}; use when starting a tree without a `.ged` / `.zip` import. */
export declare const createEmptyReadGed: (options?: {
mapFiles?: Map<string, File>;
placesMap?: Map<string, Place>;
}) => ReadGed;
export type ImportGedFileOptions = {
onProgress?: GedcomTransferProgressCallback;
};
export declare const importGedFile: (file: File, options?: ImportGedFileOptions) => Promise<ReadGed>;