mirror of
https://github.com/google/blockly.git
synced 2026-03-13 00:30:10 +01:00
39 lines
1.1 KiB
TypeScript
39 lines
1.1 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Helper function for warning developers about deprecations.
|
|
* This method is not specific to Blockly.
|
|
*
|
|
* @namespace Blockly.utils.deprecation
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.utils.deprecation');
|
|
|
|
|
|
/**
|
|
* Warn developers that a function or property is deprecated.
|
|
*
|
|
* @param name The name of the function or property.
|
|
* @param deprecationDate The date of deprecation.
|
|
* Prefer 'month yyyy' or 'quarter yyyy' format.
|
|
* @param deletionDate The date of deletion, in the same format as the
|
|
* deprecation date.
|
|
* @param opt_use The name of a function or property to use instead, if any.
|
|
* @alias Blockly.utils.deprecation.warn
|
|
* @internal
|
|
*/
|
|
export function warn(
|
|
name: string, deprecationDate: string, deletionDate: string,
|
|
opt_use?: string) {
|
|
let msg = name + ' was deprecated on ' + deprecationDate +
|
|
' and will be deleted on ' + deletionDate + '.';
|
|
if (opt_use) {
|
|
msg += '\nUse ' + opt_use + ' instead.';
|
|
}
|
|
console.warn(msg);
|
|
}
|