Bixby Developer Center

Guides
References

fail

Provides a method for handling runtime exceptions.

  • Importing with JavaScript Runtime Version 1:
      var fail = require('fail');
  • Importing with JavaScript Runtime Version 2:
      import fail from 'fail';

The following sections describe the available methods within this module. Each section includes a table that lists the parameters for that method, as well as the parameter's type and description.

fail.checkedError(message, errorId, errorObj)

Create a failure for a checked error declared and handled by the action.

Note

If you are configuring a checked error for a remote endpoint, see Error Handling in Configuring Endpoints.

Kind: Static method of fail
Returns: Object
Access: Public

ParameterTypeDescription
messageStringThe message to display to the user
errorIdStringThe ID of the dev-defined error
errorObjObjectAn object containing properties for the dev-defined error