ServerResponse Write Function for SuiteScript Development

The ServerResponse write method lets developers send string outputs (text, XML, HTML) to the client in SuiteScript applications. This method is essential for delivering data-driven responses in server-side scripts.

Method Description

The write method writes information to the response but is limited to string values. To include files in the response, consider using the writeFile method instead.

Returns

• void: This method does not return a value.

Supported Script Types

• Server scripts

Governance

• There are no governance limits for using this method.

Module

• This method is part of the N/http Module.

Parent Object

• The parent object for this method is http.ServerResponse.

Parameters

The options parameter is a JavaScript object with the following structure:

Errors

When using this method, be mindful of the following potential errors:

Syntax

The following code sample illustrates the syntax for the write method:

1// Add additional code 
2...
3serverResponse.write({
4    output: 'Hello World'
5});
6...
7// Add additional code

Related Topics

• http.ServerResponse
• N/http Module
• SuiteScript 2.x Modules
• SuiteScript 2.x

Key Takeaways

• The write method is used to output string data directly to the HTTP response.
• Proper error handling ensures that required string outputs are checked before execution.
• Understanding the distinctions between write and writeFile aids in managing responses correctly.