Documentation: README.md suggest a broken way to extend BaseLogger

[BenceSzalai]

Describe the bug
The documentation here suggests to extend BaseLogger as:

export class CustomLogger<LogObj> extends BaseLogger<LogObj> {
  constructor(settings?: ISettingsParam<LogObj>, logObj?: LogObj) {
    super(settings, logObj, 5); // not valid any more
  }
}

However since v4.8.3 constructor of BaseLogger was changed to include a new first parameter runtime.

What is the recommended way to extend the logger now?

[BenceSzalai]

I guess the README could be upgraded to:

import { BaseLogger, Runtime } from 'tslog'

export class CustomLogger<LogObj> extends BaseLogger<LogObj> {
  constructor(settings?: ISettingsParam<LogObj>, logObj?: LogObj) {
    super(Runtime, settings, logObj, 5);
  }
}

[BenceSzalai]

Also this part is broken now:

  public custom(...args: unknown[]): LogObj & ILogObjMeta {
    return super.log(8, "CUSTOM", ...args);
  }

because BaseLogger log method is declared to have a return type of (LogObj & ILogObjMeta) | undefined instead of LogObj & ILogObjMeta since 7f0670e#diff-94d248e9814c5047f571ddc28ee1895f22e9a8243907cf67066a4265c9858e71 .

[terehov]

Thank you for pointing this out. You're right. I'll update the docs.

[terehov]

To be honest, it shouldn't have happened, especially since it was just a minor update. I must have overlooked that during a PR merge. Sorry about that.
I moved the runtime into the BaseLogger, so the API can remain the same. I will release a patch shortly.

[terehov]

Solved in V4.9.1.

[BenceSzalai]

Probably should have opened a separate issue, but I thought both were about updateing documentation. So the part about public custom(...args: unknown[]): LogObj & ILogObjMeta { is still invalid.

[terehov]

Thank you, I updated the docs:

https://github.com/fullstack-build/tslog#custom-log-level