Class Index | File Index

Classes


Class Name

A class to parse names of people. Different locales have different conventions when it comes to naming people.

The options can contain any of the following properties:

When the parser has completed its parsing, it fills in the fields listed below.

For names that include auxilliary words, such as the family name "van der Heijden", all of the auxilliary words ("van der") will be included in the field.

For names in Spanish locales, it is assumed that the family name is doubled. That is, a person may have a paternal family name followed by a maternal family name. All family names will be listed in the familyName field as normal, separated by spaces. When formatting the short version of such names, only the paternal family name will be used.
Defined in: ilib-full-dyn.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Name(name, options)
Method Summary
Method Attributes Method Name and Description
 
 
When sorting names with auxiliary words (like "van der" or "de los"), determine which is the "head word" and return a string that can be easily sorted by head word.
Class Detail
Name(name, options)
Parameters:
{string|Name=} name
the name to parse
{Object=} options
Options governing the construction of this name instance
Method Detail
clone()

{string|undefined} getSortFamilyName()
When sorting names with auxiliary words (like "van der" or "de los"), determine which is the "head word" and return a string that can be easily sorted by head word. In English, names are always sorted by initial characters. In places like the Netherlands or Germany, family names are sorted by the head word of a list of names rather than the first element of that name.
Returns:
{string|undefined} a string containing the family name[s] to be used for sorting in the current locale, or undefined if there is no family name in this object

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 02 2016 15:53:55 GMT-0800 (PST)