fix(typings): Add comment property

[ffflorian]

After #71 was merged, the typings were not updated.

cc @sparticvs

[sparticvs]

Thanks @ffflorian. New to typescript, good to know that is needed.

[patrickhulce]

thanks very much @ffflorian!

I think we should augment the decode return types with this though since encode won't do anything with the comments

maybe just & {comment?: string} onto the decode return type declarations?

[ffflorian]

@patrickhulce good idea. But the question is: does encode accept the comments option? If yes I think it should stay like this.

[patrickhulce]

does encode accept the comments option? If yes I think it should stay like this.

Depends on your definition of "accept" :)

It won't throw an error, but it won't do anything at all with them either. Their existence of comments in the typedef of encode in this PR suggests to a consumer that it's an optional parameter that might affect the behavior of encode (i.e. that encode has the ability to encode comments into the output buffer when it doesn't). comments support is exclusive to decode. Does that make sense?

[ffflorian]

It won't throw an error, but it won't do anything at all with them either. Their existence of comments in the typedef of encode in this PR suggests to a consumer that it's an optional parameter that might affect the behavior of encode (i.e. that encode has the ability to encode comments into the output buffer when it doesn't). comments support is exclusive to decode. Does that make sense?

Yes, that totally makes sense! I'll update my PR later :)

[ffflorian]

@patrickhulce PR updated :)

[patrickhulce]

oof, I'm so sorry @ffflorian but I had a typo in my original suggestion.

with these suggestions it looks great though! :)