Module:Util/cargo/all/Documentation/Spec

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search

Documentation for this module may be created at Module:Util/cargo/all/Documentation/Spec/Documentation

local p = {}

function p.Schemas()
	return {
		["..."] = {
			type = "array",
			required = true,
			items = {
				oneOf = {
					{
						type = "string",
					},
					{
						type = "map",
						keys = { type = "string" },
						values = { type = "string" },
					},
				},
			}
		},
	}
end

function p.Documentation()
	return {
		params = {"..."},
		returns = "A WHERE clause with ANDed conditions and [[Module:Util/cargo/escape|escaped]] quotation marks.",
		cases = {
			outputOnly = true,
			{
				args = {
					{
						game = "Link's Awakening",
						remakeNum = 2,
					},
					"foo HOLDS 'bar'",
					"baz LIKE '%quux%'",
				},
				expect = [[(remakeNum='2') AND (game='Link\'s Awakening') AND (foo HOLDS 'bar') AND (baz LIKE '%quux%')]]
			}
		},
	}
end

return p