Skip to content

chore: fix/tighten type definition for pcp ws #4430

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

Closed
wridgeu wants to merge 2 commits into from
+8 −8
Closed

chore: fix/tighten type definition for pcp ws #4430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2308ab
chore(types): adjust/tighten pcp fields
wridgeu Apr 11, 2026
2441296
chore(types): wire through type fix of aProtocols
wridgeu Apr 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/sap.ui.core/src/sap/ui/core/ws/SapPcpWebSocket.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ sap.ui.define(['./WebSocket', "sap/base/Log"],
* Creates a new WebSocket connection and uses the pcp-protocol for communication.
*
* @param {string} sUrl relative or absolute URL for WebSocket connection.
* @param {array} [aProtocols] array of protocols as strings, a single protocol as a string.
* @param {string|string[]} [aProtocols] array of protocols as strings, a single protocol as a string.
* Protocol(s) should be selected from {@link sap.ui.core.ws.SapPcpWebSocket.SUPPORTED_PROTOCOLS}.
*
* @public
Expand Down Expand Up @@ -39,7 +39,7 @@ sap.ui.define(['./WebSocket', "sap/base/Log"],
* @param {sap.ui.base.EventProvider} oControlEvent.getSource
* @param {object} oControlEvent.getParameters
* @param {string} oControlEvent.getParameters.data Received data from the server.
* @param {string} oControlEvent.getParameters.pcpFields Received pcpFields as a key-value map.
* @param {Object<string,string>} oControlEvent.getParameters.pcpFields Received pcpFields as a key-value map.
* @public
*/

Expand All @@ -48,7 +48,7 @@ sap.ui.define(['./WebSocket', "sap/base/Log"],
*
* @param {object} [oParameters] Parameters to pass along with the event
* @param {string} [oParameters.data] Received data from the server.
* @param {string} [oParameters.pcpFields] Received pcpFields as a key-value map.
* @param {Object<string,string>} [oParameters.pcpFields] Received pcpFields as a key-value map.
* @return {this} <code>this</code> to allow method chaining
* @protected
* @name sap.ui.core.ws.SapPcpWebSocket#fireMessage
Expand Down Expand Up @@ -245,7 +245,7 @@ sap.ui.define(['./WebSocket', "sap/base/Log"],
* when the connection is established.
*
* @param {string|Blob|ArrayBuffer} message message to send
* @param {object} [oPcpFields] additional pcp-fields as key-value map
* @param {Object<string,any>} [oPcpFields] additional pcp-fields as key-value map
* @return {this} Reference to <code>this</code> to allow method chaining
* @public
*/
Expand All @@ -261,4 +261,4 @@ sap.ui.define(['./WebSocket', "sap/base/Log"],

return SapPcpWebSocket;

});
});
6 changes: 3 additions & 3 deletions src/sap.ui.core/src/sap/ui/core/ws/WebSocket.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sap.ui.define([
* Creates a new WebSocket connection.
*
* @param {string} sUrl relative or absolute URL for WebSocket connection.
* @param {array} [aProtocols] array of protocols as strings, a single protocol as a string
* @param {string|string[]} [aProtocols] array of protocols as strings, a single protocol as a string
* @public
*
* @class Basic WebSocket class.
Expand Down Expand Up @@ -393,7 +393,7 @@ sap.ui.define([
* Opens the connection and binds the event-handlers.
*
* @param {string} sUrl URL for WebSocket
* @param {array} [aProtocols] array of protocols as strings, a single protocol as a string
* @param {string|string[]} [aProtocols] array of protocols as strings, a single protocol as a string
* @private
*/
WebSocket.prototype._openConnection = function(sUrl, aProtocols) {
Expand Down Expand Up @@ -544,4 +544,4 @@ sap.ui.define([

return WebSocket;

});
});