ToolParameter Object Members in SuiteScript 2.1

The ToolParameter object is an essential part of SuiteScript 2.1, allowing developers to create parameters that can be used in server scripts. This article delves into its members, illustrating how they can be leveraged to improve script functionality.

What are ToolParameter Object Members?

The ToolParameter object consists of several properties that define parameters in server scripts. Here are the key members:

Property Details

• description: A string that provides a description of the tool parameter to enhance clarity and usability.
• name: A string that indicates the name assigned to the parameter.
• type: A string that specifies the type of the parameter, such as STRING or other appropriate types available within SuiteScript.

Error Handling

When using the ToolParameter properties, developers should note that attempting to set any of these properties after their initial assignment will lead to a READ_ONLY error.

Example Syntax

To illustrate how the ToolParameter object members can be utilized, consider the following example:

1// Create a tool parameter
2const userNameParameter = llm.createToolParameter({
3    name: "userName",
4    description: "Name of the user",
5    type: llm.ToolParameterType.STRING
6});
7 
8// Accessing parameter properties
9const toolParameterDescription = userNameParameter.description;

This code sample demonstrates creating a ToolParameter and accessing its description.

Summary

The ToolParameter object is an integral part of developing server scripts in SuiteScript 2.1, allowing for enhanced parameter management and improved script interactions. Properly understanding its members and usage patterns will equip developers with the ability to write more flexible and powerful scripts.

Key Takeaways

• The ToolParameter object is crucial for defining parameters in server scripts.
• Each member of ToolParameter enhances clarity and script functionality.
• Incorrect attempts to modify property values result in READ_ONLY errors.