Class: MemberHelper

MemberHelper

new MemberHelper()

Helper class for converting and retrieving members to/from the database

Source:
Requires:

Requires

Members

schema :JSONSchema

Type:
  • JSONSchema
Source:

Methods

(static) transformMembers(rows) → {Member|Array.<Member>}

Transform normalized database rows to JSON

Parameters:
Name Type Description
rows MemberRow | Array.<MemberRow>

flat object(s) returned by database
Source:
Returns:

inflated member objects(s)

Type
Member | Array.<Member>

getMemberByID(idnullable) → {Promise}

Retrieve member(s) based on id

Parameters:
Name Type Attributes Description
id string | Array.<string> | Object <nullable>

one or more ids

  • (string | string[]) bioguide id(s), array will retrieve multiple

  • object if specifying id other than bioguide. If multiple id's are present, all will be retrieved. ex) {'thomas_id': (string | string[])}

    supports:

    • bioguide_id
    • thomas_id
    • govtrack_id
    • lis_id (only available for senators)

  • null will retrieve all
Source:
Returns:

a promise that will resolve with a list of members

Type
Promise

getMemberByName(name, modeopt) → {Promise}

Retrieve member(s) based on name

Parameters:
Name Type Attributes Default Description
name string

name or name fragment to look for
mode number <optional>
 0

which degree of exact-ness to match the name

  • 0: any partial match
  • 1: exact match on either first, last or full name
  • 2: exact match on full name
Source:
Returns:

a promise that will resolve with an array of members

Type
Promise