foundation-utils.logger.deprecated

Home > @genesislcap/foundation-utils > Logger > deprecated

Logger.deprecated() method

A logger method for deprecated symbols.

Signature:

deprecated(symbol: string, instruction?: string, removalVersionTarget?: string): void;

Parameters

Parameter	Type	Description
symbol	string	The deprecated symbol.
instruction	string	(Optional) An optional alternative instruction. Defaults to Consult docs for better alternative.
removalVersionTarget	string	(Optional) An optional target removal version number.

Returns:

void

Remarks

Pair with a deprecated tag. See https://tsdoc.org/pages/tags/deprecated/ for more information.

Example 1

logger.deprecated('someSymbol');

Example 2

With a custom instruction and target removal version.

logger.deprecated('routeButtons', 'Use the default slot instead.', '20.0.0');