Skip to content

Latest commit

 

History

History
199 lines (151 loc) · 5.97 KB

README.md

File metadata and controls

199 lines (151 loc) · 5.97 KB
Raw

us-presidents

Search, fetch, and get data regarding United States presidents.

GitHub Documentation Discord Examples

Installation

NPM 
npm install us-presidents
Yarn 
yarn add us-presidents

Data

import { presidents } from "us-presidents";

console.log(presidents); //Array of objects containing info about all US presidents

Note: The const { presidents } = require("us-presidents"); common.js syntax is also supported, this applies to the functions as well.

Functions

randomPresident()

Gets a random president.

import { randomPresident } from "us-presidents";

console.log(randomPresident());

/*
Example Response:

{
  order: 23,
  name: 'Benjamin Harrison',
  description: 'Benjamin Harrison was an American lawyer and politician who served as the 23rd president of the United States from 1889 to 1893. He was a grandson of the ninth president, William Henry Harrison, and a great-grandson of Benjamin Harrison V, a founding father who signed the United States Declaration of Independence.',
  wikipedia: 'https://wikipedia.org/wiki/Benjamin_Harrison',
  term: { startYear: 1889, endYear: 1893, served: 1 },
  party: 'Republican',
  life: { birthYear: 1833, deathYear: 1901 }
}
*/
searchPresidents(query: string)

Search presidents by their name.

Note: Consider using findPresident() instead.

import { searchPresidents } from "us-presidents";

console.log(searchPresidents("donald trump")); //Returns a array of results, in this case it will only be one result
/*
[
  {
    order: 45,
    name: 'Donald Trump',
    description: 'Donald John Trump is an American politician, media personality, and businessman who served as the 45th president of the United States from 2017 to 2021.',
    wikipedia: 'https://en.wikipedia.org/wiki/Donald_Trump',
    term: { startYear: 2017, endYear: 2021, served: 1 },
    party: 'Republican',
    life: { birthYear: 1946, deathYear: null }
  }
]
*/

console.log(searchPresidents("donald trump")[0]); //Returns the first result, instead of an array of results
findPresident(query: string)

Find a president using their exact name.

import { findPresident } from "us-presidents";

console.log(findPresident("Donald Trump"));
/*
{
  order: 45,
  name: 'Donald Trump',
  description: 'Donald John Trump is an American politician, media personality, and businessman who served as the 45th president of the United States from 2017 to 2021.',
  wikipedia: 'https://en.wikipedia.org/wiki/Donald_Trump',
  term: { startYear: 2017, endYear: 2021, served: 1 },
  party: 'Republican',
  life: { birthYear: 1946, deathYear: null }
}
*/
searchPresidentsByTerm(year: number, type: PartOfTerm)

Returns an array of presidents who started and/or ended their term in a certain year.

import { searchPresidentsByTerm, PartOfTerm } from "us-presidents";

console.log(searchPresidentsByTerm(2021, PartOfTerm.Either));
/*
Returns Donald Trump and Joe Biden because Trump's end year was 2021, and Biden's start year was 2021:
[
  {
    order: 45,
    name: 'Donald Trump',
    description: 'Donald John Trump is an American politician, media personality, and businessman who served as the 45th president of the United States from 2017 to 2021.',
    wikipedia: 'https://en.wikipedia.org/wiki/Donald_Trump',
    term: { startYear: 2017, endYear: 2021, served: 1 },
    party: 'Republican',
    life: { birthYear: 1946, deathYear: null }
  },
  {
    order: 46,
    name: 'Joe Biden',
    description: 'Joseph Robinette Biden Jr. is an American politician who is the 46th and current president of the United States. A member of the Democratic Party, he served as the 47th vice president from 2009 to 2017 under Barack Obama and represented Delaware in the United States Senate from 1973 to 2009.',
    wikipedia: 'https://en.wikipedia.org/wiki/Joe_Biden',
    term: { startYear: 2021, endYear: null, served: null },
    party: 'Democrat',
    life: { birthYear: 1942, deathYear: null }
  }
]
*/

console.log(searchPresidentsByTerm(2021, PartOfTerm.Start)); //Would just return Joe Biden

console.log(searchPresidentsByTerm(2021, PartOfTerm.End)); //Would just return Donald Trump

console.log(searchPresidentsByTerm(null, PartOfTeam.End)); //Would return Joe Biden as his term doesn't have an end year yet
searchPresidentsByLife(year: number, type: PartOfLife)

Returns an array of presidents who were born and/or diseased in a certain year.

import { searchPresidentsByLife, PartOfLife } from "us-presidents";

console.log(searchPresidentsByLife(1732, PartOfLife.Either)); //Returns an array of anyone who was born or diseased in 1732, in this case only George Washington
console.log(searchPresidentsByLife(1946, PartOfLife.Birth)); //Returns an array of any president who was born in 1946, Bill Clinton; Donald Trump; and George W. Bush
console.log(searchPresidentsByLife(null, PartOfLife.Death)); //Returns an array of every president who is still alive
searchPresidentsByParty(partyName: Party)

Returns an array of all presidents of a certain party.

import { searchPresidentsByParty } from "us-presidents";

console.log(searchPresidentsByParty("Republican")); //Returns an array of all presidents of the Republican party
console.log(searchPresidentsByParty("Democrat")); //Returns an array of all presidents of the Democrat party