success()
Last updated 29/03/2023
The success() is a function on the Five object that returns a FiveError indicating success and can be used as a return value from functions to tell Five
that the outcome is successful.
Available
Client and Server
Function Signature
success([currentResult: FiveError | message: string, [message: string, [notification: string]]]) : FiveError;
| Parameter | Type | Default | Description |
|---|---|---|---|
currentResult | FiveError | null | The current result that you wish to chain this error with |
message | string | empty | Description of the error |
notification | string | empty | Notification to be displayed to the Notifications bell |