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.

Sign up for GitHub

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

Jump to bottom

Fix WS clientConfig type and clarify docs #3566

Merged
merged 1 commit into from Jun 6, 2020
Merged

Fix WS clientConfig type and clarify docs #3566

merged 1 commit into from Jun 6, 2020

Conversation

ryanio
Copy link
Collaborator

@ryanio ryanio commented Jun 3, 2020 •
edited

Description

This PR fixes the WS clientConfig type and adds to the docs for the option keepalive.

Closes #3563

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:cov and my test cases cover all the lines and branches of the added code.
  • I ran npm run build-all and tested the resulting files from dist folder in a browser.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have tested my code on the live network.
  • The browser visual inspection check looks ok: sudden-playground.surge.sh

@ryanio ryanio added Documentation Relates to project wiki or documentation Types Incorrect or missing types 1.x 1.0 related issues labels Jun 3, 2020
@ryanio ryanio changed the title Fix WS clientConfig types and clarify docs Fix WS clientConfig type and clarify docs Jun 3, 2020
@ryanio ryanio added the Review Needed Maintainer(s) need to review label Jun 3, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 89.833% when pulling 6a4bbe3 on issue/3563 into 9e46628 on 1.x.

@cgewecke cgewecke self-requested a review June 3, 2020 20:45
cgewecke
cgewecke approved these changes Jun 3, 2020
View reviewed changes
Copy link
Collaborator

@cgewecke cgewecke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet! LGTM 💯

@ryanio ryanio merged commit 076fd46 into 1.x Jun 6, 2020
@naddison36
Copy link
Contributor

Thanks @ryanio

@cgewecke cgewecke mentioned this pull request Jun 19, 2020
Closed
14 tasks
@snyk-bot snyk-bot mentioned this pull request Jan 24, 2022
Open
@mpetrunic mpetrunic deleted the issue/3563 branch October 31, 2023 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cgewecke cgewecke cgewecke approved these changes

Assignees
No one assigned
Labels
1.x 1.0 related issues Documentation Relates to project wiki or documentation Review Needed Maintainer(s) need to review Types Incorrect or missing types
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix WS clientConfig types and clarify docs
4 participants
@ryanio @coveralls @naddison36 @cgewecke