From 256275e1d630f61c9ebd296d472bf8795605921b Mon Sep 17 00:00:00 2001 From: Alison McKay Date: Fri, 18 Sep 2020 11:03:48 -0700 Subject: [PATCH] Update CustomFunctionsRuntime1.3: fix syntax error, match comments to Excel UI (#47749) * Fix parameterAddresses error in custom-functions-runtime/index.d.ts * Correct two req set numbers, update error code comments to match UI experience in types/custom-functions-runtime/index.d.ts * Fix whitespaces per npm lint --- types/custom-functions-runtime/index.d.ts | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/types/custom-functions-runtime/index.d.ts b/types/custom-functions-runtime/index.d.ts index 99dad54705..2fa966dfe0 100644 --- a/types/custom-functions-runtime/index.d.ts +++ b/types/custom-functions-runtime/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for non-npm package custom-functions-runtime 1.5 +// Type definitions for non-npm package custom-functions-runtime 1.3 // Project: https://github.com/OfficeDev/office-js // Definitions by: OfficeDev , // Adam Krantz , @@ -65,9 +65,9 @@ declare namespace CustomFunctions { * `{ "requiresParameterAddresses": true }` * * If the metadata JSON file is being generated from JSDoc comments, include the tag `@requiresParameterAddresses`. - * [Api set: CustomFunctionsRuntime 1.1] + * [Api set: CustomFunctionsRuntime 1.3] */ - parameterAddresses?: string; + parameterAddresses?: string[]; } /** @@ -103,20 +103,23 @@ declare namespace CustomFunctions { } /** - * Error codes for custom functions. These errors will appear in the cell that invoked the function. + * Error codes for custom functions. The error codes will appear in the cell that invoked the function. + * + * Custom error messages will appear in addition to these error codes. Custom messages will display in the error + * indicator menu, which is accessed by clicking the error flag on each cell with an error. */ enum ErrorCode { /** * * This error code indicates that a value used in the function is of the wrong data type. - * A custom error message can also be used in place of the error code, if desired. + * A custom error message can be used in addition to the error code, if desired. * [Api set: CustomFunctionsRuntime 1.3] */ invalidValue = "#VALUE!", /** * * This error code indicates that the function or service isn't available. - * A custom error message can also be used in place of the error code, if desired. + * A custom error message can be used in addition to the error code, if desired. * [Api set: CustomFunctionsRuntime 1.3] */ notAvailable = "#N/A", @@ -129,28 +132,28 @@ declare namespace CustomFunctions { divisionByZero = "#DIV/0!", /** * - * There is a problem with a number used in the function. + * This error code indicates that there is a problem with a number used in the function. * A custom error message can't be used. * [Api set: CustomFunctionsRuntime 1.3] */ invalidNumber = "#NUM!", /** * - * The ranges in the function don't intersect. + * This error code indicates that the ranges in the function don't intersect. * A custom error message can't be used. * [Api set: CustomFunctionsRuntime 1.3] */ nullReference = "#NULL!", /** * - * There is a typo in the function name. + * This error code indicates that there is a typo in the function name. * A custom error message can't be used. * [Api set: CustomFunctionsRuntime 1.3] */ invalidName = "#NAME?", /** * - * The function refers to an invalid cell. + * This error code indicates that the function refers to an invalid cell. * A custom error message can't be used. * [Api set: CustomFunctionsRuntime 1.3] */