Método Node.js util.deprecate()

El método util.deprecate() (agregado en v0.8.0_ es una interfaz de programación de aplicaciones incorporada del módulo util que envuelve fn (que puede ser una función o clase) de tal manera que se marca como obsoleto. Cuando util. se llama al método deprecate() , devuelve una función que emite un DeprecationWarning usando el evento de «advertencia». La primera vez que se llama a la función devuelta, la advertencia se emite y se imprime en stderr. Una vez que se emite la advertencia, la función envuelta La advertencia se emite solo una vez si se proporciona el mismo código opcional en varias llamadas a ‘ util.deprecate() ‘.

Sintaxis:

util.deprecate(fn, msg, )

Parámetros: esta función acepta tres parámetros, como se mencionó anteriormente y se describe a continuación:

• fn: es la <función> la que está en desuso.
• msg: cuando se invoca la función obsoleta, se necesita mostrar un ‘mensaje de advertencia’ <string>.
• código: Es un código de desaprobación <string> que se imprime junto con la advertencia de desaprobación. Algunas de las API en desuso son DEP0001, DEP0001, …., DEP0143.

Valor de retorno: Devuelve la función en desuso envuelta para emitir una advertencia, es decir, el mensaje de advertencia se devuelve junto con las API en desuso después de ejecutar la función completa.

Ejemplo 1: Nombre de archivo: index.js

// Node.js program to demonstrate the 
// util.deprecate() method 
  
// Import the util module 
var util = require('util');
  
var depricateFunction = util.deprecate(
  
    // Function which is depricated
    function () { },
  
    // Warning message that is 
    // printed to stderr
    "someWarningMessage",
  
    // Deprecated API
    'Deprication API'
);
  
// Function call
depricateFunction();

Ejecute el archivo index.js con el siguiente comando:

node index.js

Producción:

[Deprication API] DepricationWarning: someWarningMessage

Ejemplo 2: Nombre de archivo: index.js

// Node.js program to demonstrate the 
// util.deprecate() method 
  
// Import the util module 
var util = require('util');
var outerValue = "along with"
  
var geekyFunction1 = util.deprecate(() => {
    console.log("This Depricated function is working, ");
},
    // The arrow function which is depricated
    "geekyFunction() is deprecated. Use "
        + "geeksForGeeksFunction() instead",
  
    // The warning message that is printed
    // to stderr
    'DEP0014' // Deprecated API
);
  
var geekyFunction2 = util.deprecate(function (call) {
    console.log("This Depricated function is working, ", 
            outerValue, call());
},
    // The function which is depricated
    "geekyFunction() is deprecated. Use "
        + "geeksForGeeksFunction() instead",
    // The warning message that is printed to stderr
    'DEP0014' // Deprecated API
);
  
// Function call
geekyFunction1();
  
// Function call
geekyFunction2(function call() {
    console.log("Callback");
    return "return value"
});

Ejecute el archivo index.js con el siguiente comando:

node index.js

Producción:

Esta función en desuso está funcionando, devolución de
llamada
Esta función en desuso está funcionando, junto con el valor de retorno
[DEP0014] Advertencia de desuso: geekyFunction() está en desuso. Use geeksforgeeksFunction() en su lugar

• Se imprime un seguimiento de la pila y una advertencia en stderr la primera vez si se establecen indicadores cmd trace-deprecation/trace-warnings o si la propiedad process.traceDeprecation se establece en true .
• Se lanzará una excepción si se establece el indicador de cmd –throw-deprecation , o si process.throwDeprecation se establece en true .
• El util.deprecate() no hace nada si la propiedad process.noDeprecation se establece en verdadero, o si se utilizan indicadores de cmd sin desuso/sin advertencias .
• trace-deprecation y process.traceDeprecation tienen menor precedencia que el indicador de cmd –throw-deprecation y la propiedad process.throwDeprecation .

Referencia: https://nodejs.org/api/util.html#util_util_deprecate_fn_msg_code