billboard.js/dist-esm/module/error.js

Re-usable easy interface JavaScript chart library, based on D3 v4+

/*!
* Copyright (c) 2017 ~ present NAVER Corp.
 * billboard.js project is licensed under the MIT license
 * 
 * billboard.js, JavaScript chart library
 * https://naver.github.io/billboard.js/
 * 
 * @version 4.1.1
*/
import { API_MODULE_NEEDED, TYPE, TYPE_METHOD_NEEDED } from "../config/const.js";
import { window as win } from "./browser.js";
import { isEmpty } from "./util/type-checks.js";
import { camelize } from "./util/object.js";
//#region src/module/error.ts
const MODULE_IMPORT_DOC = "https://github.com/naver/billboard.js/blob/master/MODULE_IMPORTS.md";
/**
* Check chart type module imports.
* @param {ChartInternal} ctx Context
* @private
*/
function checkModuleImport(ctx) {
	const $$ = ctx;
	const { config } = $$;
	let type = "";
	if (isEmpty(config.data_type || config.data_types) && !$$[TYPE_METHOD_NEEDED.LINE]) type = "line";
	else for (const x in TYPE_METHOD_NEEDED) {
		const t = TYPE[x];
		if ($$.hasType(t) && !$$[TYPE_METHOD_NEEDED[x]]) {
			type = t;
			break;
		}
	}
	type && logError(`Please, make sure if %c${camelize(type)}`, "module has been imported and specified correctly.", MODULE_IMPORT_DOC);
}
/**
* Check optional API module import (e.g. export, flow).
* Invoked by stubs on Chart.prototype when the corresponding resolver module
* was not imported. Throws a helpful error pointing to the module the user
* needs to import.
* @param {string} apiName API name (key of API_MODULE_NEEDED)
* @private
*/
function checkApiModuleImport(apiName) {
	const moduleName = API_MODULE_NEEDED[apiName];
	moduleName && logError(`Please, make sure if %c${moduleName}`, "module has been imported and specified correctly.", MODULE_IMPORT_DOC);
}
/**
* Log error and throw error
* @param {string} head Message header
* @param {string} tail Message tail
* @param {string} info Info message
* @private
*/
function logError(head, tail, info) {
	const prefix = "[billboard.js]";
	if (win.console?.error) {
		const tailMsg = tail ? ["background:red;color:white;display:block;font-size:15px", tail] : [];
		console.error(`❌ ${prefix} ${head}`, "background:red;color:white;display:block;font-size:15px", ...tailMsg);
		info && console.info("%cℹ️", "font-size:15px", info);
	}
	throw Error(`${prefix} ${head.replace(/\%c([a-z-]+)/i, "'$1' ")} ${tail ?? ""}`);
}
//#endregion
export { checkApiModuleImport, checkModuleImport, logError };