Class: UserVisibleError¶
Defined in: api.ts:87
An error whose message will be shown to the end user in the UI when it occurs. If an error is encountered in a formula and you want to describe the error to the end user, throw a UserVisibleError with a user-friendly message and the Coda UI will display the message.
Example¶
if (!url.startsWith("https://")) {
throw new coda.UserVisibleError("Please provide a valid url.");
}
See¶
Extends¶
Error
Constructors¶
Constructor¶
new UserVisibleError(
message?,internalError?):UserVisibleError
Defined in: api.ts:96
Use to construct a user-visible error.
Parameters¶
| Parameter | Type |
|---|---|
message? |
string |
internalError? |
Error |
Returns¶
UserVisibleError
Overrides¶
Error.constructor