Guesses whether the party string entered is an abbreviation or the full name.
Parameters
partystring The party, either a full name or an abbrevation.
Returns string Returns "abbr" or "name".
Gets information about the party. If you do not specify a type in the second argument, it will guess the type.
Parameters
partystring The party, either a full name or an abbrevation, to get information about.typestring A type, which can be either "abbr" or "name". This argument is optional.party-timeusually can determine the type by itself, but you can declare it explicitly, just in case. (optional, defaultnull)
Examples
pt.getInfo("BJP");
//{
// name: "Bharatiya Janata Party",
// abbr: "BJP",
// founded: 1980,
// type: "national",
// location: "India",
// symbol: "Lotus"
//}
pt.getInfo("Indian National Congress");
//{
// name: "Indian National Congress",
// abbr: "INC",
// founded: 1885,
// type: "national",
// location: "India",
// symbol: "Hand"
//}
pt.getInfo("cpm");
//{
// name: "Communist Party of India (Marxist)",
// abbr: "CPI(M)",
// founded: 1964,
// type: "national",
// location: "India",
// symbol: "Hammer sickle and star",
// variations: { abbr: [ "CPM" ] }
//}
pt.getInfo("Not a real party") // { name: 'Not a real party', warning: 'No match in library' }Returns object An object with information about the party. If the party entered is not found in the library, returns an object containing the party name and a warning.
Converts a party abbreviation to its full name or vice versa. If the party entered is not found in the library, returns the party entered.
Parameters
partystring The party, either a full name or an abbrevation, to convert.optionsobject An object specifying options for the conversion. (optional, default{greedy:TRUE})options.greedyboolean Iftrue, the function does the conversion automatically and returns a string. If there is no match in the library, it will return the original string. Iffalse, the function returns an object with the propertiesabbr,nameand, when applicable,variations. (optional, defaultTRUE)options.typestring By default, the function will guess the type of the party string by matching it against the party names and abbreviations in the library. You can override this behavior and explicitly specify the type of party string by passing"abbr"or"name". (optional, defaultnull)
Examples
pt.convert("BJP"); // "Bharatiya Janata Party"
pt.convert("BJP", { greedy: false }); // { abbr: "BJP", name: "Bharatiya Janata Party" }
pt.convert("BJP", { greedy: true }); // "Bharatiya Janata Party"
pt.convert("bjp"); // "Bharatiya Janata Party"
pt.convert("cpm", { greedy: false }); // { abbr: "CPI(M)", name: "Communist Party of India (Marxist)", variations: { abbr: ["CPM"] } }
pt.convert("Indian National Congress"); // "INC"
pt.convert("Not a real party"); // "Not a real party"
pt.convert("NARP"); // "NARP"
pt.convert("narp", { type: "abbr" }); // "narp"
pt.convert("narp", { greedy: false, type: "name" }); // { name: "narp", warning: "No match in libary" }Returns (string | object) A string with the converted party or, if the conversion is not set to greedy, an object with information about the party.