NetSuite Changelog
SuiteScriptReference

N/error Module Members Reference for SuiteScript Development

The N/error module in SuiteScript enables custom error handling using SuiteScriptError objects and provides essential logging capabilities.

·3 min read·View Oracle Docs

The N/error module is critical for developers working with SuiteScript, as it provides tools for creating and handling custom errors within scripts. While this module does not throw custom errors directly, it offers a structured way to define and encapsulate errors, making it easier to manage exceptions through try-catch statements. This distinction helps ensure script executions can be handled gracefully without unexpected interruptions.

How to Use the N/error Module

The N/error module includes members that are essential for defining error types and handling script execution issues. Understanding these members is key to leveraging the module effectively in your SuiteScript projects:

N/error Module Members

Member TypeNameReturn Type / Value TypeSupported Script TypesDescription
Objecterror.SuiteScriptErrorObjectServer scriptsEncapsulates a custom SuiteScript error for any server script type.
Methoderror.create(options)error.SuiteScriptErrorServer scriptsCreates a new error.SuiteScriptError object.
Enumerror.TypeenumServer scriptsHolds string values for error types, to set the name parameter of the error.create(options) method.

SuiteScriptError Object Members

The SuiteScriptError object provides additional properties to retrieve detailed information about errors when they occur:

Member TypeNameReturn Type / Value TypeSupported Script TypesDescription
PropertySuiteScriptError.causestring (read-only)Server scriptsDescribes the cause of the error.
PropertySuiteScriptError.idstring (read-only)Server scriptsAutomatically generated error ID.
PropertySuiteScriptError.messagestring (read-only)Server scriptsDisplays error message text from the options.message parameter during error creation.
PropertySuiteScriptError.namestring (read-only)Server scriptsRepresents the error name or code set from the options.name value during error creation.
PropertySuiteScriptError.notifyOffboolean (read-only)Server scriptsSuppresses email notifications when set to true.
PropertySuiteScriptError.stackArray of strings (read-only)Server scriptsLists method calls at the time the error was thrown.
PropertySuiteScriptError.typeerror.Type (read-only)Server scriptsIndicates the error type as error.SuiteScriptError.

Best Practices

When implementing error handling in SuiteScript, consider the following best practices:

  • Always encapsulate error handling logic within try-catch statements.
  • Use custom error messages to clearly identify issues when they occur.
  • Utilize the notifyOff property judiciously to manage unnecessary email notifications.

This robust structure allows developers to handle errors smoothly, ensuring that scripts can recover or terminate gracefully without losing important execution context.

Related Topics

For further insights into error handling and logging, refer to the N/log module for enhanced logging capabilities during script execution.

Key Takeaways

  • The N/error module is essential for custom error handling in SuiteScript.
  • The error.SuiteScriptError object encapsulates details about errors.
  • Members like error.create and error.Type help streamline error management.
  • Always implement structured error handling with try-catch statements to maintain script stability.

Frequently Asked Questions (4)

How can I create a custom error using the N/error module in SuiteScript?
You can create a custom error by using the `error.create(options)` method, which returns a `SuiteScriptError` object. You'll specify options such as the error name and message to define the error details.
What is the role of the `SuiteScriptError` object in error handling?
The `SuiteScriptError` object encapsulates details about errors, providing properties like `cause`, `id`, `message`, `name`, `notifyOff`, `stack`, and `type`. These details help in identifying and managing errors effectively during script execution.
When should I use the `notifyOff` property in SuiteScript error handling?
The `notifyOff` property should be used when you want to suppress automatic email notifications for a specific error. It's advisable to use this sparingly to avoid missing important error alerts.
Can the N/error module be used for custom error handling in all types of NetSuite scripts?
No, the N/error module's `SuiteScriptError` objects and its methods are designed specifically for server scripts. This includes script types that run on the server-side, not client scripts.
Source: N/error Module Members — Oracle NetSuite Help Center. This article was generated from official Oracle documentation and enriched with additional context and best practices.

Was this article helpful?

More in SuiteScript

View all SuiteScript articles →