Module:OutputBuffer
Jump to navigation
Jump to search
This module provides an easy and efficient way to generate lengthy strings.
Usage[edit source]
First, load the module.
local newBuffer = require('Module:OutputBuffer')
Then, create the buffer and the functions that act on it.
local getBuffer, print, printf = newBuffer()
getBuffer[edit source]
local text = getBuffer(sep)
Returns the contents of the buffer, with an optional separator string sep.
print[edit source]
print(s)
Adds the string s to the buffer.
printf[edit source]
printf(s, ...)
Adds the string s to the buffer. The string is formatted with any subsequent arguments, following the rules used for string.format.
Example[edit source]
local newBuffer = require('Module:OutputBuffer')
local p = {}
function p.main()
local getBuffer, print, printf = newBuffer()
print('Welcome to the English Starfleet Logistics.')
printf('There are currently %d articles on this site.', mw.site.stats.articles)
return getBuffer(' ')
end
return p
-- Assuming this module's name is "TestModule", and that mw.site.stats.articles returns 4500000,
-- {{#invoke:TestModule|main}} would output:
-- "Welcome to the English Starfleet Logistics. There are currently 4500000 articles on this site."
External links[edit source]
- Module:OutputBuffer at Wikipedia, the free Terran-based encyclopedia that anyone can edit.
return function()
local buffer = {}
return function(sep)
local b = buffer
buffer = {}
return table.concat(b, sep)
end,
function(text)
buffer[#buffer + 1] = text
end,
function(...)
buffer[#buffer + 1] = string.format(...)
end
end