feat: showOutput option & log function

[santoshjoseph99]

Related to #184

Test file:
https://gist.github.com/santoshjoseph99/c796663002b03812cc197fe1f8bb8d38

Note:

1. I could add a parameter to logFunc to check if the message is a log or an error, since right now I'm just using console.log.
2. I could also set this up so that logFunc can be passed into PWMetrics as part of the options, so it gives more control to the caller on how to show the messages.

[denar90]

@santoshjoseph99 , huge 👍
logFunc is my dream we can have instead of console.log/console.error

I have only one concern about putting it as param when we call one or another method which needs log something

what do you think if we create class Logger, which will be singleton? By default, it will have flag showOutput: true.
Logger will have API aka log with params log(message, type), (type - will be success, error, etc)

setShowOutput can change showOutput flag value which will be used in scope of log to show or not message.

As result we can eliminate something like e.g. prepareData(events, logFunc); for each function and just import class Logger

[santoshjoseph99]

@denar90 sounds good. I'll update.

[denar90]

lgtm 👍
one nitpick, can you update docs so we can land it?

[santoshjoseph99]

@denar90 I'm not sure what you mean by the land on the docs?

Also I'm seeing a failure in CI...should I change the signature of the log function to be:

  log(msg: any, ...args: any[]) {
    if(Logger.options.showOutput){
      console.log(msg, ...args);
    }
  }

?

[denar90]

Moving thread here,

---

lgtm 👍
one nitpick, can you update docs so we can land it?

---

@denar90 I'm not sure what you mean by the land on the docs?
Also I'm seeing a failure in CI...should I change the signature of the log function to be:

  log(msg: any, ...args: any[]) {
    if(Logger.options.showOutput){
      console.log(msg, ...args);
    }
  }

?

---

Sorry, for the confusion.
I meant that it will be nice if you can update readme.md about new flag. As result we can publish new version.
And I'm ok with signature of the log function.

[denar90]

Thanks a looot 👍

[denar90]

v3.3.0 published to npm 🎉

[santoshjoseph99]

🆒