Architecture

There are three different types of source files:

1. Classes
2. Modules
3. Other

Classes

All classes extend BaseClass which contains common functionality for managing IDs and links, maintaining pointers to the SDK instance that the object is associated with, and serialization. Each class is in its own file in the src/classes directory.

Modules

Modules are groupings of common functionality. They determine the groupings contained in the SDK documentation and largely reflect the groupings contained in the API documentation.

Other

• FamilySearch.js is the main file that contains the definition of the FamilySearch class, includes all other files it needs, and handles instantiation of SDK instances.

• globals.js defines defaults for configuration options.

• helpers.js and utils.js contain utility methods. There was some attempt to distinguish the two files by having all methods which need access to an SDK instance in helpers.js and all static methods in utils.js but the separation was never completed.

• overview.js contains content for the home page of the documentation.

• plumbing.js contains methods for issuing and managing HTTP requests.

• relationshipHelpers.js is a group of methods shared by some modules to manage relationships.