33 lines
1.4 KiB
TypeScript
33 lines
1.4 KiB
TypeScript
|
export type preMessageFn = (message: string, type: 'warning' | 'note') => string | null | undefined | number;
|
||
|
|
/**
|
||
|
|
* Pre warning enable you to parse content before console.error.
|
||
|
|
* Modify to null will prevent warning.
|
||
|
|
*/
|
||
|
|
export declare const preMessage: (fn: preMessageFn) => void;
|
||
|
|
/**
|
||
|
|
* 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 declare function warning(valid: boolean, message: string): void;
|
||
|
|
/** @see Similar to {@link warning} */
|
||
|
|
export declare function note(valid: boolean, message: string): void;
|
||
|
|
export declare function resetWarned(): void;
|
||
|
|
export declare function call(method: (valid: boolean, message: string) => void, valid: boolean, message: string): void;
|
||
|
|
/** @see Same as {@link warning}, but only warn once for the same message */
|
||
|
|
export declare function warningOnce(valid: boolean, message: string): void;
|
||
|
|
export declare namespace warningOnce {
|
||
|
|
var preMessage: (fn: preMessageFn) => void;
|
||
|
|
var resetWarned: typeof import("./warning").resetWarned;
|
||
|
|
var noteOnce: typeof import("./warning").noteOnce;
|
||
|
|
}
|
||
|
|
/** @see Same as {@link warning}, but only warn once for the same message */
|
||
|
|
export declare function noteOnce(valid: boolean, message: string): void;
|
||
|
|
export default warningOnce;
|