us-presidents

Index

Enumerations

Interfaces

President

Type Aliases

Party

Variables

presidents

Functions

Type Aliases

Party

Party: "Republican" | "Democrat" | "Whig" | "Democratic-Republican" | "Federalist" | "National Union"

The party type, used in President interface and searchPresidentsByParty() function.

Variables

Const presidents

presidents: President[] = ...

Array of objects containing data about presidents.

Functions

findPresident

findPresident(name: string): President

- Defined in functions/findPresident.ts:6
Finds a president using their exact name (as used in our data sample).

Parameters
- name: string
Returns President

randomPresident

randomPresident(): President

- Defined in functions/randomPresident.ts:7
Gets a random president.

Returns President

searchPresidents

searchPresidents(query: string): President[]

- Defined in functions/searchPresidents.ts:9
Searches presidents by name.

note
Returns a empty array if no presidents are found.

deprecated
Please implement your own search function, so you can get the behavior you expect. Consider using findPresident() if you have the president's full name instead.

Parameters
- query: string
Returns President[]

searchPresidentsByLife

searchPresidentsByLife(query: number, type: PartOfLife): President[]

- Defined in functions/searchPresidentsByLife.ts:7
Searches presidents by their birth/death year.

Parameters
- query: number
- type: PartOfLife
Returns President[]

searchPresidentsByParty

searchPresidentsByParty(party: Party): President[]

- Defined in functions/searchPresidentsByParty.ts:8
Searches presidents by their party.

Parameters
- party: Party
  
  The party to search.
Returns President[]

searchPresidentsByTerm

searchPresidentsByTerm(query: number, type: PartOfTerm): President[]

- Defined in functions/searchPresidentsByTerm.ts:7
Searches presidents by their start and/or end term year.

Parameters
- query: number
- type: PartOfTerm
Returns President[]

Generated using TypeDoc