CustomFunctions.Error class

Paquete:

custom-functions-runtime

Use esta clase para controlar errores y escribir mensajes de error personalizados.

Comentarios

[ Conjunto de API: CustomFunctionsRuntime 1.2 ]

Ejemplos

/**
 * Returns the #NUM! error as part of a 2-dimensional array.
 * @customfunction
 * @param {number} first First parameter.
 * @param {number} second Second parameter.
 * @param {number} third Third parameter.
 * @returns {number[][]} Three results, as a 2-dimensional array.
 */
function returnInvalidNumberError(first, second, third) {
  // Use the `CustomFunctions.Error` object to retrieve an invalid number error.
  const error = new CustomFunctions.Error(
    CustomFunctions.ErrorCode.invalidNumber, // Corresponds to the #NUM! error in the Excel UI.
  );

  // Enter logic that processes the first, second, and third input parameters.
  // Imagine that the second calculation results in an invalid number error.
  const firstResult = first;
  const secondResult = error;
  const thirdResult = third;

  // Return the results of the first and third parameter calculations
  // and a #NUM! error in place of the second result.
  return [[firstResult], [secondResult], [thirdResult]];
};

Constructores

(constructor)(code, message)

Construye una nueva instancia de la Error clase

Propiedades

code	Código de error devuelto por la función personalizada.
message	Mensaje de error personalizado, como "Este precio de las acciones no está disponible". Los mensajes personalizados solo están disponibles con determinados códigos de error.

Detalles del constructor

(constructor)(code, message)

Construye una nueva instancia de la Error clase

constructor(code: ErrorCode, message?: string);

Parámetros

code

CustomFunctions.ErrorCode

message

string

Detalles de las propiedades

code

Código de error devuelto por la función personalizada.

code: ErrorCode;

Valor de propiedad

CustomFunctions.ErrorCode

Comentarios

[ Conjunto de API: CustomFunctionsRuntime 1.2 ]

message

Mensaje de error personalizado, como "Este precio de las acciones no está disponible". Los mensajes personalizados solo están disponibles con determinados códigos de error.

message?: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: CustomFunctionsRuntime 1.2 ]