@aventum/hooks/src/createDidHook.js

A universal, lightweight & efficient EventManager/PluginsSystem/MiddlewareManager/ExtendabilitySystem for JavaScript

/**
 * Internal dependencies
 */
import validateHookName from './validateHookName.js';

/**
 * Returns a function which, when invoked, will return the number of times a
 * hook has been called.
 *
 * @param  {Object}   hooks Stored hooks, keyed by hook name.
 *
 * @return {Function}       Function that returns a hook's call count.
 */
function createDidHook( hooks ) {
	/**
	 * Returns the number of times an action has been fired.
	 *
	 * @param  {string} hookName The hook name to check.
	 *
	 * @return {number}          The number of times the hook has run.
	 */
	return function didHook( hookName ) {
		if ( ! validateHookName( hookName ) ) {
			return;
		}

		return hooks[ hookName ] && hooks[ hookName ].runs ?
			hooks[ hookName ].runs :
			0;
	};
}

export default createDidHook;