wails/runtime/js/runtime/events.js

/*
 _       __      _ __    
| |     / /___ _(_) /____
| | /| / / __ `/ / / ___/
| |/ |/ / /_/ / / (__  ) 
|__/|__/\__,_/_/_/____/  
The lightweight framework for web-like apps
(c) Lea Anthony 2019-present
*/
/* jshint esversion: 6 */


/**
 * Registers an event listener that will be invoked `maxCallbacks` times before being destroyed
 *
 * @export
 * @param {string} eventName
 * @param {function} callback
 * @param {number} maxCallbacks
 */
function OnMultiple(eventName, callback, maxCallbacks) {
	window.wails.Events.OnMultiple(eventName, callback, maxCallbacks);
}

/**
 * Registers an event listener that will be invoked every time the event is emitted
 *
 * @export
 * @param {string} eventName
 * @param {function} callback
 */
function On(eventName, callback) {
	OnMultiple(eventName, callback);
}

/**
 * Registers an event listener that will be invoked once then destroyed
 *
 * @export
 * @param {string} eventName
 * @param {function} callback
 */
function Once(eventName, callback) {
	OnMultiple(eventName, callback, 1);
}


/**
 * Emit an event with the given name and data
 *
 * @export
 * @param {string} eventName
 */
function Emit(eventName) {
	return window.wails.Events.Emit(eventName);
}


/**
 * Heartbeat emits the event `eventName`, every `timeInMilliseconds` milliseconds until 
 * the event is acknowledged via `Event.Acknowledge`. Once this happens, `callback` is invoked ONCE
 *
 * @export
 * @param {string} eventName
 * @param {number} timeInMilliseconds
 * @param {function} callback
 */
function Heartbeat(eventName, timeInMilliseconds, callback) {
	window.wails.Events.Heartbeat(eventName, timeInMilliseconds, callback);
}

/**
 * Acknowledges a heartbeat event by name
 *
 * @export
 * @param {string} eventName 
 */
function Acknowledge(eventName) {
	return window.wails.Events.Acknowledge(eventName);
}

module.exports = {
	OnMultiple,
	On,
	Once,
	Emit,
	Heartbeat,
	Acknowledge
};