read-gedcom-utils

Index

Interfaces

Type aliases

Variables

defaultFiliationParameters

Functions

Type aliases

DateInterval

DateInterval: [Date | null, Date | null]

GenderedParameter

GenderedParameter: number | PreciseGenderedParameter

Variables

defaultFiliationParameters

defaultFiliationParameters: { datePlusMinus: number; maxAge: { female: number; male: number }; maxParentAge: { female: number; male: number }; maxPregnancyDuration: number; maxYear: null | number; minParentAge: { female: number; male: number } } = ...

Type declaration

datePlusMinus: number
maxAge: { female: number; male: number }
- female: number
- male: number
maxParentAge: { female: number; male: number }
- female: number
- male: number
maxPregnancyDuration: number
maxYear: null | number
minParentAge: { female: number; male: number }
- female: number
- male: number

Functions

Const containsCycle

containsCycle(gedcom: SelectionGedcom, options?: CycleDetectionOptions): boolean

- Defined in graph.ts:19
Checks whether this graph contains a cycle, with respect to the filiation relation (or CycleDetectionOptions.adjacency if defined).

Parameters
- gedcom: SelectionGedcom
  
  The gedcom root selection
- options: CycleDetectionOptions = {}
  
  Additional options
Returns boolean

Const estimateIndividualsDates

estimateIndividualsDates(gedcom: SelectionGedcom, parameters?: FiliationParameters): EstimatedDates

- Defined in individualDates.ts:67
Parameters
- gedcom: SelectionGedcom
- Optional parameters: FiliationParameters
Returns EstimatedDates

Const familyChildrenFiliation

familyChildrenFiliation(family: SelectionFamilyRecord): SelectionIndividualRecord

- Defined in filiation.ts:3
Parameters
- family: SelectionFamilyRecord
Returns SelectionIndividualRecord

Const parentChildrenFiliation

parentChildrenFiliation(parent: SelectionIndividualRecord): SelectionIndividualRecord

- Defined in filiation.ts:5
Parameters
- parent: SelectionIndividualRecord
Returns SelectionIndividualRecord

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

DateInterval

GenderedParameter

Variables

defaultFiliationParameters

Type declaration

datePlusMinus: number

maxAge: { female: number; male: number }

female: number

male: number

maxParentAge: { female: number; male: number }

female: number

male: number

maxPregnancyDuration: number

maxYear: null | number

minParentAge: { female: number; male: number }

female: number

male: number

Functions

Const containsCycle

Parameters

gedcom: SelectionGedcom

options: CycleDetectionOptions = {}

Returns boolean

Const estimateIndividualsDates

Parameters

gedcom: SelectionGedcom

Optional parameters: FiliationParameters

Returns EstimatedDates

Const familyChildrenFiliation

Parameters

family: SelectionFamilyRecord

Returns SelectionIndividualRecord

Const parentChildrenFiliation

Parameters

parent: SelectionIndividualRecord

Returns SelectionIndividualRecord