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

Incorrect options typings #203

Open
isaachinman opened this issue Jan 2, 2024 · 3 comments
Open

Incorrect options typings #203

isaachinman opened this issue Jan 2, 2024 · 3 comments

Comments

@isaachinman
Copy link

Some options, including keepAlive, are specifically documented here.

The keepAlive option (and probably others, didn't check) are not present in the package typings:

Object literal may only specify known properties, and 'keepAlive' does not exist in type 'Options'
@isaachinman
Copy link
Author

Dug into the source code and found this:

962beac#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edR16

So, this is simply a case of incorrect documentation, not typings.

@shawnpetros
Copy link

somewhat related, the typings for the constructor seem to require host whereas docs claim it's optional. in the typings host is marked as required.

@isaachinman
Copy link
Author

I'm not sure if Pusher is a failed company or what, but they do not maintain their software, so do not expect a fix anytime soon.

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