stomp-js / rx-stomp

STOMP adaptor for RxJS
Apache License 2.0
112 stars 21 forks source link

Documentation fix for RxStompConfig #432

Closed brandonfl closed 2 years ago

brandonfl commented 2 years ago

Hello, here is little error found into doc page https://stomp-js.github.io/api-docs/latest/classes/RxStompConfig.html :

"call RxStomp#decativate in this callback" :

Capture d’écran de 2022-02-09 15-28-13

"will receive [RxStomp](@link RxStomp) as parameter." :

Capture d’écran de 2022-02-09 15-37-17

"Maps to: [Client#heartbeatIncoming]{@Client#heartbeatIncoming}" :

Capture d’écran de 2022-02-09 15-42-14

"Maps to: [Client#reconnectDelay]{@Client#reconnectDelay}" :

Capture d’écran de 2022-02-09 15-43-22

Here is a little PR to fix it

kum-deepak commented 2 years ago

Many thanks for the PR. It is really appreciated. I will merge it and add your name to the list of contributors.

kum-deepak commented 2 years ago

If you are up for it, please free to create more PRs, no need to attach screenshots.

kum-deepak commented 2 years ago

It is now updated in the develop version. https://stomp-js.github.io/api-docs/develop/classes/RxStompConfig.html

I will make an npm release tomorrow, then it will reflect in latest as well.

brandonfl commented 2 years ago

Will check to do more other PRs :smiley:

kum-deepak commented 2 years ago

I will wait for these and then make a single npm release.

brandonfl commented 2 years ago

I will wait for these and then make a single npm release.

@kum-deepak I do it when having more time, I can't tell when for now

kum-deepak commented 2 years ago

No rush! :smile: