Skip to content

Commit

Permalink
Update index.js
Browse files Browse the repository at this point in the history
  • Loading branch information
patmmccann authored Jul 9, 2024
1 parent 4fdbedb commit 4bfc8f3
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions modules/rtdModule/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,10 +188,12 @@ let _dataProviders = [];
let _userConsent;

/**
* Register a RTD submodule.
* Register a Real-Time Data (RTD) submodule.
*
* @param {RtdSubmodule} submodule
* @returns {function()} a de-registration function that will unregister the module when called.
* @param {Object} submodule The RTD submodule to register.
* @param {string} submodule.name The name of the RTD submodule.
* @param {number} [submodule.gvlid] The Global Vendor List ID (GVLID) of the RTD submodule.
* @returns {function(): void} A de-registration function that will unregister the module when called.
*/
export function attachRealTimeDataProvider(submodule) {
registeredSubModules.push(submodule);
Expand Down

0 comments on commit 4bfc8f3

Please sign in to comment.