Skip to content
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

Open
timotheeg opened this issue Sep 2, 2021 · 2 comments
Open

Document the mandatory name constructor option #159

timotheeg opened this issue Sep 2, 2021 · 2 comments

Comments

@timotheeg
Copy link

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 as name - 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!

@timotheeg
Copy link
Author

timotheeg commented Sep 2, 2021

Plus it looks like the constructor supplies a default value, so I'm not sure why the parameter is mandatory in the typescript definition?

this.name = options.name || 'CloudWatch';

@lazywithclass
Copy link
Owner

I should put that as optional, I cannot remember why this name attribute is there to be honest with you, I believe it was being used in an older version of the package.
I will have a look at this and then push out a fix as it seems trivial.

eirikurn added a commit to island-is/island.is that referenced this issue Nov 15, 2021
Using default value. Can be removed again when this issue is resolved:

lazywithclass/winston-cloudwatch#159
kodiakhq bot added a commit to island-is/island.is that referenced this issue Nov 24, 2021
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants