Skip to content

[tools] (YML) Expand type aliases to include links #2249

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.

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
merged 15 commits into from
Apr 23, 2025
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
234 changes: 117 additions & 117 deletions docs/docs-ref-autogen/common/toc.yml

Large diffs are not rendered by default.

236 changes: 118 additions & 118 deletions docs/docs-ref-autogen/common_preview/toc.yml

Large diffs are not rendered by default.

26 changes: 16 additions & 10 deletions docs/docs-ref-autogen/excel/custom-functions-runtime.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,22 @@ name: custom-functions-runtime
type: package
summary: ''
interfaces:
- 'custom-functions-runtime!CustomFunctions.CancelableInvocation:interface'
- 'custom-functions-runtime!CustomFunctions.Invocation:interface'
- 'custom-functions-runtime!CustomFunctions.StreamingInvocation:interface'
- custom-functions-runtime!CustomFunctions.CancelableInvocation:interface
- custom-functions-runtime!CustomFunctions.Invocation:interface
- custom-functions-runtime!CustomFunctions.StreamingInvocation:interface
classes:
- 'custom-functions-runtime!CustomFunctions.Error:class'
- custom-functions-runtime!CustomFunctions.Error:class
enums:
- 'custom-functions-runtime!CustomFunctions.ErrorCode:enum'
- custom-functions-runtime!CustomFunctions.ErrorCode:enum
functions:
- name: 'CustomFunctions.associate(id, functionObject)'
uid: 'custom-functions-runtime!CustomFunctions.associate:function(1)'
- name: CustomFunctions.associate(id, functionObject)
uid: custom-functions-runtime!CustomFunctions.associate:function(1)
package: custom-functions-runtime!
summary: Associates the JavaScript function to the name given by the "id" property in the metadata JSON file.
summary: >-
Associates the JavaScript function to the name given by the "id" property
in the metadata JSON file.
remarks: ''

isPreview: false
isDeprecated: false
syntax:
Expand All @@ -32,10 +35,13 @@ functions:
type: void
description: ''
- name: CustomFunctions.associate(mappings)
uid: 'custom-functions-runtime!CustomFunctions.associate:function(2)'
uid: custom-functions-runtime!CustomFunctions.associate:function(2)
package: custom-functions-runtime!
summary: Associates the JavaScript functions to the names given by the "id" properties in the metadata JSON file.
summary: >-
Associates the JavaScript functions to the names given by the "id"
properties in the metadata JSON file.
remarks: ''

isPreview: false
isDeprecated: false
syntax:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,33 +1,40 @@
### YamlMime:TSType
name: CustomFunctions.CancelableInvocation
uid: 'custom-functions-runtime!CustomFunctions.CancelableInvocation:interface'
uid: custom-functions-runtime!CustomFunctions.CancelableInvocation:interface
package: custom-functions-runtime!
fullName: CustomFunctions.CancelableInvocation
summary: >-
Provides information about the invocation of a cancelable custom function. A cancelable custom function can provide a
handler for the onCanceled event.
Provides information about the invocation of a cancelable custom function. A
cancelable custom function can provide a handler for the onCanceled event.


To indicate that a function is cancelable, in the metadata JSON file, the function options should specify: `{
"cancelable": true }`
To indicate that a function is cancelable, in the metadata JSON file, the
function options should specify: `{ "cancelable": true }`


If the metadata JSON file is being generated from JSDoc comments, include the tag `@cancelable`<!-- -->.
If the metadata JSON file is being generated from JSDoc comments, include the
tag `@cancelable`<!-- -->.
remarks: ''

isPreview: false
isDeprecated: false
type: interface
events:
- name: onCanceled
uid: 'custom-functions-runtime!CustomFunctions.CancelableInvocation#onCanceled:member'
uid: >-
custom-functions-runtime!CustomFunctions.CancelableInvocation#onCanceled:member
package: custom-functions-runtime!
fullName: onCanceled
summary: Event handler called when the custom function is canceled.
remarks: '\[ [API set: CustomFunctionsRuntime 1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]'
remarks: >-
\[ [API set: CustomFunctionsRuntime
1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
\]

isPreview: false
isDeprecated: false
syntax:
content: 'onCanceled?: () => void;'
return:
type: () =&gt; void
extends: '<xref uid="custom-functions-runtime!CustomFunctions.Invocation:interface" />'
extends: <xref uid="custom-functions-runtime!CustomFunctions.Invocation:interface" />
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
### YamlMime:TSType
name: CustomFunctions.Error
uid: 'custom-functions-runtime!CustomFunctions.Error:class'
uid: custom-functions-runtime!CustomFunctions.Error:class
package: custom-functions-runtime!
fullName: CustomFunctions.Error
summary: Use this class to handle errors and write custom error messages.
remarks: |-
\[ [API set: CustomFunctionsRuntime 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]
remarks: >-
\[ [API set: CustomFunctionsRuntime
1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
\]


#### Examples


```TypeScript

/**
* Returns the #NUM! error as part of a 2-dimensional array.
* @customfunction
Expand All @@ -34,49 +39,62 @@ remarks: |-
// and a #NUM! error in place of the second result.
return [[firstResult], [secondResult], [thirdResult]];
};

```

isPreview: false
isDeprecated: false
type: class
constructors:
- name: '(constructor)(code, message)'
uid: 'custom-functions-runtime!CustomFunctions.Error:constructor(1)'
- name: (constructor)(code, message)
uid: custom-functions-runtime!CustomFunctions.Error:constructor(1)
package: custom-functions-runtime!
fullName: '(constructor)(code, message)'
fullName: (constructor)(code, message)
summary: Constructs a new instance of the `Error` class
remarks: ''

isPreview: false
isDeprecated: false
syntax:
content: 'constructor(code: ErrorCode, message?: string);'
parameters:
- id: code
description: ''
type: '<xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum" />'
type: >-
<xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum"
/>
- id: message
description: ''
type: string
properties:
- name: code
uid: 'custom-functions-runtime!CustomFunctions.Error#code:member'
uid: custom-functions-runtime!CustomFunctions.Error#code:member
package: custom-functions-runtime!
fullName: code
summary: The error code returned by your custom function.
remarks: '\[ [API set: CustomFunctionsRuntime 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]'
remarks: >-
\[ [API set: CustomFunctionsRuntime
1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
\]

isPreview: false
isDeprecated: false
syntax:
content: 'code: ErrorCode;'
return:
type: '<xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum" />'
type: <xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum" />
- name: message
uid: 'custom-functions-runtime!CustomFunctions.Error#message:member'
uid: custom-functions-runtime!CustomFunctions.Error#message:member
package: custom-functions-runtime!
fullName: message
summary: >-
Your custom error message, such as "This stock price is unavailable". Custom messages are only available with
certain error codes.
remarks: '\[ [API set: CustomFunctionsRuntime 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]'
Your custom error message, such as "This stock price is unavailable".
Custom messages are only available with certain error codes.
remarks: >-
\[ [API set: CustomFunctionsRuntime
1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
\]

isPreview: false
isDeprecated: false
syntax:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
### YamlMime:TSEnum
name: CustomFunctions.ErrorCode
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode:enum'
uid: custom-functions-runtime!CustomFunctions.ErrorCode:enum
package: custom-functions-runtime!
fullName: CustomFunctions.ErrorCode
summary: >-
Error codes for custom functions. The error codes 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 appear in addition to these error codes. Custom messages display in the error indicator menu,
which is accessed by hovering over the error flag on each cell with an error.
Custom error messages appear in addition to these error codes. Custom messages
display in the error indicator menu, which is accessed by hovering over the
error flag on each cell with an error.
remarks: |-


Expand Down Expand Up @@ -40,53 +42,62 @@ remarks: |-
return [[firstResult], [secondResult], [thirdResult]];
};
```

isPreview: false
isDeprecated: false
fields:
- name: divisionByZero
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.divisionByZero:member'
uid: custom-functions-runtime!CustomFunctions.ErrorCode.divisionByZero:member
package: custom-functions-runtime!
summary: >-
This error code indicates that the function used is dividing by zero or empty cells. A custom error message can't
be used.
This error code indicates that the function used is dividing by zero or
empty cells. A custom error message can't be used.
value: '"#DIV/0!"'
- name: invalidName
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidName:member'
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidName:member
package: custom-functions-runtime!
summary: >-
This error code indicates that there is a typo in the function name. Note that this error code is supported as a
custom function input error, but not as a custom function output error. A custom error message can't be used.
This error code indicates that there is a typo in the function name. Note
that this error code is supported as a custom function input error, but
not as a custom function output error. A custom error message can't be
used.
value: '"#NAME?"'
- name: invalidNumber
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidNumber:member'
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidNumber:member
package: custom-functions-runtime!
summary: >-
This error code indicates that there is a problem with a number in the function. A custom error message can't be
used.
This error code indicates that there is a problem with a number in the
function. A custom error message can't be used.
value: '"#NUM!"'
- name: invalidReference
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidReference:member'
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidReference:member
package: custom-functions-runtime!
summary: >-
This error code indicates that the function refers to an invalid cell. Note that this error code is supported as a
custom function input error, but not as a custom function output error. A custom error message can't be used.
This error code indicates that the function refers to an invalid cell.
Note that this error code is supported as a custom function input error,
but not as a custom function output error. A custom error message can't be
used.
value: '"#REF!"'
- name: invalidValue
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidValue:member'
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidValue:member
package: custom-functions-runtime!
summary: >-
This error code indicates that a value in the function is of the wrong data type. A custom error message can be
used in addition to the error code, if desired.
This error code indicates that a value in the function is of the wrong
data type. A custom error message can be used in addition to the error
code, if desired.
value: '"#VALUE!"'
- name: notAvailable
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.notAvailable:member'
uid: custom-functions-runtime!CustomFunctions.ErrorCode.notAvailable:member
package: custom-functions-runtime!
summary: >-
This error code indicates that the function or service isn't available. A custom error message can be used in
addition to the error code, if desired.
This error code indicates that the function or service isn't available. A
custom error message can be used in addition to the error code, if
desired.
value: '"#N/A"'
- name: nullReference
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.nullReference:member'
uid: custom-functions-runtime!CustomFunctions.ErrorCode.nullReference:member
package: custom-functions-runtime!
summary: This error code indicates that the ranges in the function don't intersect. A custom error message can't be used.
summary: >-
This error code indicates that the ranges in the function don't intersect.
A custom error message can't be used.
value: '"#NULL!"'
Loading