64 lines
1.8 KiB
JavaScript
64 lines
1.8 KiB
JavaScript
|
/* eslint-disable no-console */
|
||
|
|
let warned = {};
|
||
|
|
const preWarningFns = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Pre warning enable you to parse content before console.error.
|
||
|
|
* Modify to null will prevent warning.
|
||
|
|
*/
|
||
|
|
export const preMessage = fn => {
|
||
|
|
preWarningFns.push(fn);
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Warning if condition not match.
|
||
|
|
* @param valid Condition
|
||
|
|
* @param message Warning message
|
||
|
|
* @example
|
||
|
|
* ```js
|
||
|
|
* warning(false, 'some error'); // print some error
|
||
|
|
* warning(true, 'some error'); // print nothing
|
||
|
|
* warning(1 === 2, 'some error'); // print some error
|
||
|
|
* ```
|
||
|
|
*/
|
||
|
|
export function warning(valid, message) {
|
||
|
|
if (process.env.NODE_ENV !== 'production' && !valid && console !== undefined) {
|
||
|
|
const finalMessage = preWarningFns.reduce((msg, preMessageFn) => preMessageFn(msg ?? '', 'warning'), message);
|
||
|
|
if (finalMessage) {
|
||
|
|
console.error(`Warning: ${finalMessage}`);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/** @see Similar to {@link warning} */
|
||
|
|
export function note(valid, message) {
|
||
|
|
if (process.env.NODE_ENV !== 'production' && !valid && console !== undefined) {
|
||
|
|
const finalMessage = preWarningFns.reduce((msg, preMessageFn) => preMessageFn(msg ?? '', 'note'), message);
|
||
|
|
if (finalMessage) {
|
||
|
|
console.warn(`Note: ${finalMessage}`);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
export function resetWarned() {
|
||
|
|
warned = {};
|
||
|
|
}
|
||
|
|
export function call(method, valid, message) {
|
||
|
|
if (!valid && !warned[message]) {
|
||
|
|
method(false, message);
|
||
|
|
warned[message] = true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/** @see Same as {@link warning}, but only warn once for the same message */
|
||
|
|
export function warningOnce(valid, message) {
|
||
|
|
call(warning, valid, message);
|
||
|
|
}
|
||
|
|
|
||
|
|
/** @see Same as {@link warning}, but only warn once for the same message */
|
||
|
|
export function noteOnce(valid, message) {
|
||
|
|
call(note, valid, message);
|
||
|
|
}
|
||
|
|
warningOnce.preMessage = preMessage;
|
||
|
|
warningOnce.resetWarned = resetWarned;
|
||
|
|
warningOnce.noteOnce = noteOnce;
|
||
|
|
export default warningOnce;
|