How to Correctly Remove All Line Items from a NetSuite Sublist Using SuiteScript 2.x

Observe the two code snippets below, demonstrating an incorrect and a correct approach to removing sublist items in SuiteScript 2.x. The key difference lies in how the removal operation handles the dynamic re-indexing of sublist lines.

INCORRECT APPROACH

javascript
for(var i = 0; i < currentRecord.getLineCount({ sublistId: 'item' }); i++){
    currentRecord.removeLine({ sublistId: 'item', line: i });
}

In the above snippet, which represents a common intuitive approach, the issue arises because once a line item is removed, the sublist re-indexes. This adjustment means that the line count and the indices of remaining items change. For example, if a sublist has three items (indexed 0, 1, 2):

LINE 1 [index 0] LINE 2 [index 1] LINE 3 [index 2]

1. currentRecord.removeLine({ sublistId: 'item', line: 0 }) removes LINE

   1.

   Result: LINE 2 [index 0] LINE 3 [index 1]

2. The loop increments i to 1. currentRecord.removeLine({ sublistId: 'item', line: 1 }) removes LINE 3 (which was originally LINE 3, now at index 1).

   Result: LINE 2 [index 0]

   The loop then terminates as i is now greater than the line count, leaving LINE 2 unremoved.

   CORRECT APPROACH

   A straightforward and reliable method to address this is to consistently remove the first element (index 0) until no items remain in the sublist. This approach works because removing the first item always shifts the subsequent items to fill the gap, making the 'new' first item always available at index 0.

javascript
while(currentRecord.getLineCount({ sublistId: 'item' }) > 0){
    currentRecord.removeLine({ sublistId: 'item', line: 0 });
}

This will result in the following example execution:

Consider the same initial sublist:

LINE 1 [index 0] LINE 2 [index 1] LINE 3 [index 2]

1. currentRecord.removeLine({ sublistId: 'item', line: 0 }) removes LINE

   1.

   Result: LINE 2 [index 0] LINE 3 [index 1]

2. currentRecord.removeLine({ sublistId: 'item', line: 0 }) removes LINE

   2.

   Result: LINE 3 [index 0]

3. currentRecord.removeLine({ sublistId: 'item', line: 0 }) removes LINE

   3.

   Result: (Empty Sublist)

   This ensures all items are correctly removed without any indexing complications.