getMembersByFirstName

getMembersByFirstName() - version 1.0.0

The getMembersByFirstName method is used to return the list of members with a specified first name.

About

• Input Parameters: string - members first name.
  
• Return Type: object[] - on success, an array of member objects (if no matches then an empty array). On error, an error message.
• Important Note: this method cannot be called before the login method.

Example

const Chapter = require("acm-roster");

async function main() {
    const client = new Chapter();
    var memberList = [];
    try {
      // log in to ACM client
      await client.login("username", "password");

      // get members with first name "Matthew"
      memberList = await client.getMembersByFirstName("Matthew");

      if (memberList.length === 0) {
        console.log("no member found with that first name.");
      } else {
        console.log(memberList);
      }
    } catch (err) {
      console.log("-- Critical --");
      throw err;
    }
}

main()