@v4fire/client/src/core/event/index.ts

V4Fire client core library

/*!
 * V4Fire Client Core
 * https://github.com/V4Fire/Client
 *
 * Released under the MIT license
 * https://github.com/V4Fire/Client/blob/master/LICENSE
 */

/**
 * [[include:core/event/README.md]]
 * @packageDocumentation
 */

import SyncPromise from 'core/promise/sync';
import { deprecate } from 'core/functools/deprecation';

export * from '@v4fire/core/core/event';

/**
 * Returns a promise that will be resolved after the `DOMContentLoaded` event
 */
export function resolveAfterDOMLoaded(): SyncPromise<void> {
	return new SyncPromise((resolve) => {
		if (document.readyState === 'loading') {
			document.addEventListener('DOMContentLoaded', resolve);

		} else {
			resolve();
		}
	});
}

/**
 * @deprecated
 * @see [[resolveAfterDOMLoaded]]
 */
export const afterDOMLoaded = deprecate(
	{
		alternative: 'resolveAfterDOMLoaded'
	},

	function afterDOMLoaded(cb?: AnyFunction): SyncPromise<void> {
		const
			promise = resolveAfterDOMLoaded();

		if (cb) {
			void promise.then(cb);
		}

		return promise;
	}
);