feat(core events): Add await_pattern_init helper which can be used to await the event when a pattern instance is initialized.

Author: thet

src/core/events.js

@@ -77,6 +77,22 @@ const await_event = (el, event_name) => {
     );
 };
 
+/**
+ * Await pattern init.
+ *
+ * Usage:
+ *     await events.await_pattern_init(PATTERN);
+ *
+ * @param {Pattern instance} pattern - The pattern instance.
+ *
+ * @returns {Promise} - Returns a Promise which can be used for ``await`` and which will be resolved when the event is throwm.
+ *
+ */
+const await_pattern_init = (pattern) => {
+    // See: https://stackoverflow.com/a/44746691/1337474
+    return new Promise((resolve) => pattern.one("init", resolve));
+};
+
 /**
  * Event factories
  */
@@ -120,6 +136,7 @@ export default {
     add_event_listener: add_event_listener,
     remove_event_listener: remove_event_listener,
     await_event: await_event,
+    await_pattern_init: await_pattern_init,
     click_event: click_event,
     change_event: change_event,
     input_event: input_event,

src/core/events.test.js

@@ -1,3 +1,4 @@
+import Base from "./base";
 import events from "./events";
 import utils from "./utils";
 
@@ -60,6 +61,22 @@ describe("core.events tests", () => {
             // If test reaches this expect statement, all is fine.
             expect(true).toBe(true);
         });
+
+        it("Awaits a pattern to be initialized", async () => {
+            const pat = Base.extend({
+                name: "tmp",
+                trigger: ".pat-tmp",
+                init: function () {},
+            });
+
+            const el = document.createElement("div");
+            const instance = new pat(el);
+
+            await events.await_pattern_init(instance);
+
+            // If test reaches this expect statement, all is fine.
+            expect(true).toBe(true);
+        });
     });
 
     describe("2 - event factories", () => {