RoadmapShopEvents
Skip to main content

Home > @rushstack/node-core-library > StringBuilder

StringBuilder class

This class allows a large text string to be constructed incrementally by appending small chunks. The final string can be obtained by calling StringBuilder.toString().

Signature:
export declare class StringBuilder implements IStringBuilder
Implements: [IStringBuilder](/pages/node-core-library.istringbuilder)

Remarks

A naive approach might use the += operator to append strings: This would have the downside of copying the entire string each time a chunk is appended, resulting in O(n^2) bytes of memory being allocated (and later freed by the garbage collector), and many of the allocations could be very large objects. StringBuilder avoids this overhead by accumulating the chunks in an array, and efficiently joining them when getText() is finally called.

Constructors

ConstructorModifiersDescription
(constructor)()Constructs a new instance of the StringBuilder class

Methods

MethodModifiersDescription
append(text)Append the specified text to the buffer.
toString()Returns a single string containing all the text that was appended to the buffer so far.