Description
- Package Name: @azure/web-pubsub-express
- Package Version: 1.0.3
- Operating system:
- nodejs
- version:
- browser
- name/version:
- typescript
- version: 4.9.3
- Is the bug related to documentation in
- README.md
- source code documentation
- SDK API docs on https://docs.microsoft.com
Describe the bug
Attribute 'queries' of a ConnectRequest object is not available when using handleConnect event in a WebPubSubEventHandler.
The returned object has actually a query attribute instead of the queries one that is declared in the ConnectRequest interface (file web-pubsub-express.d.ts).
To Reproduce
Steps to reproduce the behavior:
- Declare a new WebPubSubEventHandler with an 'handleConnect' event.
- When a connection event arrives, the content of the 'ConnectRequest' object is not matching its interface described in web-pubsub-express.d.ts package generated file (see enclosed screenshots).
Workaround : replace 'queries' by 'query' attribute in webpubsub-express.d.ts (not recommended) or replace the 'ConnectRequest' object type in the declaration by 'any'.
Expected behavior
To be compliant with the documentation the returned object should have its attribute 'query' replaced by 'queries'. A fix is needed to comply with the documentation.
Screenshots
Additional context
Add any other context about the problem here.