Skip to content

Commit

Permalink
FIO-9201: Add new parameter into jsdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
mikekotikov committed Oct 23, 2024
1 parent 97bdca1 commit 7932dfa
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/sdk/Formio.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2367,6 +2367,7 @@ export class Formio {
* @param {string} property - The name of the global property that will be added to the global namespace once the library has been loaded. This is used to check to see if the property exists before resolving the promise that the library is ready for use.
* @param {string} src - The URL of the library to lazy load.
* @param {boolean} polling - Determines if polling should be used to determine if they library is ready to use. If set to false, then it will rely on a global callback called ${name}Callback where "name" is the first property passed to this method. When this is called, that will indicate when the library is ready. In most cases, you will want to pass true to this parameter to initiate a polling method to check for the library availability in the global context.
* @param {HTMLElement} rootElement - The element after which the resource would be attached (useful when requiring resources from ShadowRoot).
* @return {Promise<object>} - A promise that will resolve when the plugin is ready to be used.
*/
static requireLibrary(name: string, property: string, src: string | Array<string>, polling: boolean = false, onload?: (ready: Promise<any>) => void, rootElement?: HTMLElement ) {
Expand Down

0 comments on commit 7932dfa

Please sign in to comment.