Editing Module:Buffer/doc (section)

{{Module rating |release<!-- Values:  pre-alpha • alpha • beta • release • protected  --  If a rating not needed/relevant, delete this template call -->}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-risk|2,000,000+}}
{{TOC right}}
{{Module rating|protected}}
This was originally developed to optimize string concatenation as a helper method within [[Module:Asbox]], but has been generalized for all modules.

The interface for [[#Buffer object|Module:Buffer objects]] is similar to that of {{Luaref|HTML_library|mw.html}} objects in that you may build complex strings with independent child nodes. In most cases, you may use Buffer objects like a normal string, including using {{code|..}} operator. See also: [[#String, mw.ustring, and mw.text libraries]]

Additionally, there are several specialized forms and extended objects, described further in their respective sections:

*{{luaself|:stream|plain=y}}
*{{luaself|\-HTML|plain=y}}
*{{luaself|pre=Element-|\|plain=y}}
*{{luaself|\-variable|plain=y}}
*{{luaself|\-nil|plain=y}}
*[[#_G object|_G (callable)]]

Last but not least, this module has an ordered [[#require'Module:Buffer'.__pairs|__pairs]] which can be more thorough than {{luaref|ipairs||y}} and {{luaref|pairs||y}}. (Even reads nil keys!) The <span title='This is a bad Star Trek joke'>logical uniqueness</span> of this iterator may be reason enough to {{luaref|require|assimilate|y}} Module:Buffer.