read-gedcom
Version:
Gedcom file reader
23 lines (22 loc) • 1.17 kB
TypeScript
import { ValuePartDate } from './dates';
import { ValueExactDate } from './ValueExactDate';
import { ValueExactTime } from './ValueExactTime';
/**
* Converts a parsed Gedcom date to its corresponding JS date (expressed in the Gregorian calendar).
* The supported calendars are: Gregorian, Julian and French Republican.
* The Hebrew calendar is not yet supported. Unknown calendars are inherently unsupported.
* Dual dates will not be converted. BCE dates will be converted assuming the existence of year 0.
* In any of these cases the returned value will be <code>null</code>.
* The argument is assumed to be correct, that is of correct format and valid date.
* This is already guaranteed by {@link parseDate}.
* @param date The parsed date to convert
* @category Parsed value converters
*/
export declare const toJsDate: (date: ValuePartDate) => Date | null;
/**
* Converts a parsed Gedcom date and optional time into the corresponding JS datetime.
* @param date The parsed date
* @param time And optional parsed time
* @category Parsed value converters
*/
export declare const toJsDateTime: (date: ValueExactDate, time?: ValueExactTime) => Date | null;