gedcom-js

!CircleCI branch
!GitHub

Convert a GEDCOM file into a JS object.

Usage

Yarn

``
yarn add gedcom-js
`

NPM

`
npm i -s gedcom-js
`

API

.parse(string)

> const string = fs.readFileSync("path/file.ged", "utf8");

Example

Input:

`
0 @P1@ INDI
1 BIRT
2 DATE 1980-07-31
2 PLAC Godric's Hollow, England, Great Britain
1 NAME Harry /Potter/
1 SEX M
1 FAMC @F1@
0 @P2@ INDI
1 BIRT
2 PLAC England, Great Britain
2 DATE 1960-03-27
1 NAME James /Potter/
1 SEX M
1 FAMC @F2@
1 FAMS @F1@
1 DEAT
2 PLAC Godric's Hollow, England, Great Britain
2 DATE 1981-10-31
0 @P3@ INDI
1 BIRT
2 PLAC Cokeworth, Midlands, England, Great Britain
2 DATE 1960-01-30
1 NAME Lily /Evans/
1 SEX F
1 FAMS @F1@
1 DEAT
2 PLAC Godric's Hollow, England, Great Britain
2 DATE 1981-10-31
0 @F1@ FAM
1 HUSB @P2@
1 WIFE @P3@
1 CHIL @P1@
`

Output:

`
{
"individuals": [
{
"id": "I1",
"gender": "M",
"names": [{ "fname": "Harry", "lname": "Potter" }],
"births": [
{
"date": "1980-07-31",
"place": {
"id": "P1",
"name": "Cokeworth, Midlands, England, Great Britain"
},
}
],
"children": [],
"parents": [
{
"id": "I2",
"relation": "father",
"fname": "James",
"lname": "Potter"
},
{
"id": "I3",
"relation": "mother",
"fname": "Lily",
"lname": "Evans"
}
],
"deaths": [],
},
{
"id": "I2",
"gender": "M",
"names": [{ "fname": "James", "lname": "Potter" }],
"births": [
{
"date": "1960-03-27",
"place": {
"id": "P3",
"name": "England, Great Britain"
},
}
],
"children": [{ "id": "I1", "fname": "Harry", "lname": "Potter" }],
"parents": [],
"deaths": [
{
"date": "1981-10-31",
"place": {
"id": "P2",
"name": "Godric's Hollow, England, Great Britain"
}
}
]
},
{
"id": "I3",
"gender": "F",
"names": [{ "fname": "Lily", "lname": "Evans" }],
"births": [
{
"date": "1960-01-30",
"place": {
"id": "P1",
"name": "Cokeworth, Midlands, England, Great Britain"
},
}
],
"children": [{ "id": "I1", "fname": "Harry", "lname": "Potter" }],
"parents": [],
"deaths": [
{
"date": "1981-10-31",
"place": {
"id": "P2",
"name": "Godric's Hollow, England, Great Britain"
}
}
]
}
],
"places": [
{
"id": "P1",
"name": "Cokeworth, Midlands, England, Great Britain",
"count": 2
},
{
"id": "P2",
"name": "Godric's Hollow, England, Great Britain",
"count": 1
},
{
"id": "P3",
"name": "England, Great Britain",
"count": 1
}
],
}
``

Roadmap

- Improve this README
- Add more information about individuals
- ~~Birth~~
- Marriage
- ~~Death~~
- Baptism
- ...
- ~~Parse places~~
- Parse sources

License

MIT