Best Practices for Asynchronous Programming in SuiteScript

TL;DR Opening

Effective asynchronous programming in SuiteScript requires adherence to best practices involving promises and the async/await keywords. By implementing these guidelines, developers can write cleaner, more efficient code that enhances application performance.

Best Practices for Asynchronous Programming with SuiteScript

When implementing asynchronous programming using promises in SuiteScript, developers should consider the following best practices. If using SuiteScript 2.1, leverage the async and await keywords for a clearer syntax instead of relying solely on the promise keyword.

Best Practices for Coding Promises

• Always handle rejection: Include a promise.catch handler to manage errors effectively.
• Avoid nesting promises: Instead, chain your promises to improve readability and maintainability. Alternatively, utilize async/await functionality.
• Limit promise chain length: Keep chains short to maintain low memory and CPU usage.
• Use promise.finally: To execute cleanup or follow-up code regardless of the promise's success or failure.
• Leverage promise.all: For handling multiple unrelated asynchronous operations simultaneously.
• Avoid inline rejection handlers: Use promise.catch instead of defining rejection handlers within promise.then calls.
• Access parallel results with promise.spread: To retrieve results from running promises concurrently.
• Control concurrency using promise.map: To limit the number of concurrent operations processed.
• Use promise.then effectively: To execute code after the promise resolves.

Best Practices When Using async and await

• Refactor promise code: Rewrite existing promise-based code to utilize async/await for more straightforward syntax.
• Order your code: Schedule operations first and await their completion afterward for better logical flow.
• Avoid mixing APIs: Steer clear of combining callback-based APIs with promise-based APIs to prevent complications.
• Refrain from using return await: This practice is often unnecessary and can lead to confusion.
• Note module compatibility: For server-side SuiteScript 2.1 scripts, ensure that your code only uses modules that support async and await, which include: N/http, N/https, N/llm, N/query, N/search, and N/transaction.

By adhering to these best practices, you can maximize the efficiency and reliability of your asynchronous programming in SuiteScript.

Source: This article is based on Oracle's official NetSuite documentation.

Key Takeaways

• Employ best practices for promises to enhance error management and readability.
• Use async/await for cleaner asynchronous code structures.
• Ensure compatibility of modules when working with async and await in SuiteScript 2.1.