Source: url-util-instance-jsdoc.js

  1. /**
  2. * This is the global variable when you create the pagehelper instance.
  3. * const pageHelper = new PageHelper();
  4. * @namespace
  5. */
  6. var pageHelper = {
  7. /**
  8. * The element with special attributes to be used to generate the full url
  9. * like ph-params=""
  10. * @param {HTMLHtmlElement} ele - The html element with special attributes to be used to generate the full url
  11. * @param {string} dataUrl - The url to calculate the full url from
  12. * @instance
  13. */
  14. fullUrl(ele, dataUrl) {
  15. },
  16. /**
  17. * polling the endpoint with the given interval and fire the event specified
  18. * @param {string} url - The url to be polled
  19. * @param {Object} kvs - the interval to poll the endpoint
  20. * @param {string} kvs.interval - the interval to poll the endpoint
  21. * @param {string} kvs.eventName - the event to be fired when the polling is done
  22. * @param {function} kvs.stopWhen - the function to stop the polling
  23. * @returns {PollingService} - the polling service
  24. * @instance
  25. */
  26. getPollingService(url, kvs) {
  27. },
  28. /**
  29. * show topbar with the given delay
  30. * @param {number} delay
  31. */
  32. showTopbar(delay) {},
  33. /**
  34. * hide topbar
  35. */
  36. hideTopbar() {}
  37. };
  38. /** Polling Service. */
  39. class PollingService {
  40. /**
  41. * Start polling the endpoint
  42. */
  43. startPolling() {
  44. }
  45. /**
  46. * Stop polling the endpoint
  47. */
  48. stopPolling() {
  49. }
  50. }