Module:StringBuilder/doc: Difference between revisions

== `StringBuilder` Module Documentation ==

The `StringBuilder` module provides functionality to efficiently build and manipulate strings in Lua.

'''`StringBuilder.new()`'''

Creates a new `StringBuilder` object.

* '''Returns:''' `StringBuilder` object.

'''`StringBuilder:append(...)`'''

Appends strings or values to the `StringBuilder` buffer.

   * `...`: One or more values to append to the buffer.

'''`StringBuilder:appendLine(...)`'''

Appends strings or values followed by a newline (`\n`) to the `StringBuilder` buffer.

   * `...`: One or more values to append to the buffer.

'''`StringBuilder:clear()`'''

Clears the contents of the `StringBuilder` buffer.

* '''Usage:''' Call this method to reset the `StringBuilder` buffer to an empty state.

'''`StringBuilder:toString()`'''

Converts the `StringBuilder` buffer into a concatenated string.

* '''Returns:''' Concatenated string representation of the `StringBuilder` buffer.

To use the `StringBuilder` module in your Lua scripts, follow these examples: