success()
Last updated 17/09/2024
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]]) : 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 |
Return Value
Returns a
FiveError
object.