jessevdp / magister-tools Goto Github PK

Why?

Promises are cool! and allow for even cleaner code.

But I want them now!

You can simply wrap your existing code in promises if you specifically need promises for certain reasons. There's even cool modules that help you "promisify" all your code. Like promisify-node.

(Just googling "node promise" all or "promisify" will get you the desired results.)

Why?

I think it's a more correct name to describe what the function actually does... Since it takes a list of grades as parameter and filters the end/average grades from it, then returns an Object filled with these grades.

Add a settings parameter to the getEndGrades function. This settings object should determine the behavior of the function and/or what the returnObject looks like.

For instance:

{
  full_class_name: true || false // Default false
}

Why

Using the module right now results in quite a lot of code still. The Goal of this module is to write less and do more! That's why I think there should be shortcut functions.

Since the module basically does one thing right now, getting the end/average grades for a specified user I think that's the only shortcut function there needs to be.

Important

All the other functions should still be available because:

• It's easier to branch off and add features to the module if all the functions to for example get the current course for a user still exist.
• Some people might want to use those specific functions still.

Conclusion

Shortcuts are the way to go and will provide extra usability for this module, however, they should be an enhancement to the existing functions and not become the whole module.

fetchEndGrades(magisterlogin, callback[, doFirst])
or
fetchEndGrades(magisterlogin, callback[, settings])
Where settings is the settings object that's currently being passed into the getEndGrades() function.