mirror of
https://github.com/flarum/framework.git
synced 2025-02-27 16:25:26 +08:00
27 lines
1.3 KiB
TypeScript
27 lines
1.3 KiB
TypeScript
/**
|
|
* Calls `console.warn` with the provided arguments, but only if the forum is in debug mode.
|
|
*
|
|
* This function is intended to provide warnings to extension developers about issues with
|
|
* their extensions that may not be easily noticed when testing, such as accessibility
|
|
* issues.
|
|
*
|
|
* These warnings should be hidden on production forums to ensure webmasters are not
|
|
* inundated with do-gooders telling them they have an issue when it isn't something they
|
|
* can fix.
|
|
*/
|
|
export default function fireDebugWarning(...args: Parameters<typeof console.warn>): void;
|
|
/**
|
|
* Fire a Flarum deprecation warning which is shown in the JS console.
|
|
*
|
|
* These warnings are only shown when the forum is in debug mode, and the function exists to
|
|
* reduce bundle size caused by multiple warnings across our JavaScript.
|
|
*
|
|
* @param message The message to display. (Short, but sweet, please!)
|
|
* @param githubId The PR or Issue ID with more info in relation to this change.
|
|
* @param [removedFrom] The version in which this feature will be completely removed. (default: 2.0)
|
|
* @param [repo] The repo which the issue or PR is located in. (default: flarum/core)
|
|
*
|
|
* @see {@link fireDebugWarning}
|
|
*/
|
|
export declare function fireDeprecationWarning(message: string, githubId: string, removedFrom?: string, repo?: string): void;
|