fhtl-fstypes
v1.0.0
Published
TypeScript interfaces and types for publicly available FamilySearch API endpoints. Intended for use in the BYU Family History Technology Lab
Readme
fhtl-fstypes
npm install fhtl-fstypes
Notice
These type definitions are based on publicly available schema information from the FamilySearch API documentation. This package is an independent community project and is not endorsed by or affiliated with FamilySearch.
File Structure And Organization
These files are global type declarations for your TypeScript project, intended for improving the develpment experience for third party FamilySearch integrations. Intellisense will recognize these types without you having to import them in every file like import { type MyType } from "./secretly_nonexistent_file.ts'.
src/fstypes
The files in src/fstypes exactly mirror those defined by FamilySearch in both order (alphabetical) and structure (the same attributes). Assuming that FamilySearch continues to order their JSON Schema alphabetically, we found it best to add each type to its own individual file in order to make the project easily discernable and maintainable in the future, should updates be needed.
