Skip to content

Update CustomFunctionsRuntime1.3: fix syntax error, match comments to Excel UI #47749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ElizabethSamuel-MSFT merged 3 commits into from
Sep 18, 2020
Merged

Update CustomFunctionsRuntime1.3: fix syntax error, match comments to Excel UI #47749

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eea621f
Fix parameterAddresses error in custom-functions-runtime/index.d.ts
alison-mk Sep 18, 2020
d9be2c3
Correct two req set numbers, update error code comments to match UI e…
alison-mk Sep 18, 2020
0c2efe4
Fix whitespaces per npm lint
alison-mk Sep 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions types/custom-functions-runtime/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/OfficeDev>,
// Adam Krantz <https://github.com/akrantz>,
Expand Down Expand Up @@ -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[];
}

/**
Expand Down Expand Up @@ -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",
Expand All @@ -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]
*/
Expand Down