Improve category types #21
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #21 +/- ##
==========================================
- Coverage 97.24% 97.24% -0.01%
==========================================
Files 10 10
Lines 1018 1016 -2
Branches 217 217
==========================================
- Hits 990 988 -2
Misses 28 28 ☔ View full report in Codecov by Sentry. |
| getChild( | ||
| subcategory: string | readonly [string] | readonly [string, ...string[]], | ||
| ): Logger; | ||
| getChild(subcategory: Category): Logger; |
There was a problem hiding this comment.
We should not allow empty arrays here.
There was a problem hiding this comment.
why?
I have a case where I generate category dynamically and it can be empty. In the case of this lib there is no real difference between returning current logger from getChild or returning a child as new instance. We just need to get the correct logger.
There was a problem hiding this comment.
In my fork I even made that if a category is empty string, empty array, null or undefined then it will return current logger instead of new child
Seems ok by me)
There was a problem hiding this comment.
I think it's misleading that the method name is getChild() but the object returned is clearly not a child logger, and I don't want the signature of the method to change. 🤔
logtape/logger.ts
Outdated
| private constructor(parent: LoggerImpl | null, category: readonly string[]) { | ||
| constructor(parent: LoggerImpl | null, category: CategoryList) { |
There was a problem hiding this comment.
Why did you remove the private keyword?
There was a problem hiding this comment.
was playing with class inheritance. this can be rolled back
| | string | ||
| | readonly [string] | ||
| | readonly [string, ...(readonly string[])], | ||
| subcategory: Category, |
There was a problem hiding this comment.
We should not allow empty arrays here.
| @@ -692,7 +686,7 @@ export class LoggerCtx implements Logger { | |||
| } | |||
|
|
|||
| getChild( | |||
| subcategory: string | readonly [string] | readonly [string, ...string[]], | |||
| subcategory: Category, | |||
There was a problem hiding this comment.
We should not allow empty arrays here.
logtape/category.ts
Outdated
| export type CategoryList = Readonly<string[]>; | ||
|
|
||
| export type Category = string | CategoryList; |
There was a problem hiding this comment.
Could you add TSDoc comments for those two types?
No description provided.