Permanently protected module

Module:Util

From Yugipedia
Revision as of 17:48, 3 May 2018 by Becasita (talk | contribs) (Create utilities module.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
-- <pre>
-- @name Util
-- @description Holds commonly used simple functions.
-- @author [[User:Becasita]]
-- @contact [[User talk:Becasita]]

-------------------
-- Export variable:
-------------------
local U = {};

-------------
-- Functions:
-------------
-- @name trim
-- @description Trims white space from front and tail of string. Returns nil if only whitespace.
-- @see [[mw:Extension:Scribunto/Lua reference manual#mw.text.trim]]
function U.trim( s )
	if s and not s:match( '^%s*$' ) then
		return mw.text.trim( s );
	end
end

-- @name count
-- @description Counts the number of elements in a table.
function U.count( t )
	local counter = 0;
	for key, value in pairs( t ) do
		counter = counter + 1;
	end
	return counter;
end

-- @name link
--[=[function U.link( page, label )
	return ('[[%s|%s]]'):format( page, label or mw.text.split(  ) ) or ('[[%s]]'):format( page );
end]=]

-- @name isSomething
-- @description Meta-function for type checkers.
local function isSomething( toCompare, compareTo )
	return type( toCompare ) == type( compareTo );
end

-- @name isNumber
function U.isNumber( v )
	return isSomething( v, 1 );
end

-- @name isString
function U.isString( v )
	return isSomething( v, 1 );
end

-- @name isTable
function U.isTable( v )
	return isSomething( v, 1 );
end

----------
-- Return:
----------
return U;
-- </pre>