-
Notifications
You must be signed in to change notification settings - Fork 105
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document the mandatory name
constructor option
#159
Comments
Plus it looks like the constructor supplies a default value, so I'm not sure why the parameter is mandatory in the typescript definition? Line 17 in d77124f
|
I should put that as optional, I cannot remember why this |
Using default value. Can be removed again when this issue is resolved: lazywithclass/winston-cloudwatch#159
* chore(core): Upgrade winston-cloudwatch and pac-resolver * Add newly required name argument. Using default value. Can be removed again when this issue is resolved: lazywithclass/winston-cloudwatch#159 Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
Hi there,
The typescript definition states
name
is mandatory as a constructor option, but the construction samples in the readme do not use it, which is a little confusing.In the readme,
name
is listed asname - string
with no indication of what it is for or that it is mandatory.This is causing typescript compilation failure on code that was previously working, so documentation to know how to proceed would be great :)
Thank you!
The text was updated successfully, but these errors were encountered: