User:Gurch/Snuggle documentation

General

apply

(function, object, ...) → object

Evaluates the specified function with remaining parameters as arguments.

assign (:=)

(string, object) → object

Assigns a value to an identifier. Returns the value that was assigned.

boolean

object → boolean

Returns boolean representation of argument.

function

(args:object, ..., expression:object) → function

Returns a function. expression is expression to be evaluated, args are identifiers appearing in expression, which are substituted for argument values when the function is called.

if

(boolean, object, object) → object

(boolean, object) → object

If first argument is true, evaluates and returns second argument, otherwise evaluates and returns third argument, or false if no third argument is provided. Does not evaluate the argument that is not returned.

is

(object, string) → boolean

Returns true if argument 1 is of type given by argument 2, otherwise false.

number

object → number

Returns numeric representation of argument.

sequence (;)

(object, ...) → object

Evaluates arguments in order, returns value of last one.

string

object → string

Returns string representation of argument.

switch

(value:object, {test:object, expression:object}...) → object

Conditionally evaluates one or more expressions based on value. Arguments following first are in pairs; for each pair, if test is equal to value, expression is evaluated. Last expression evaluated is returned. test can be a list, in which case expression will be evaluated if any item in test is equal to value.

type

object → string

Returns type of argument.

wikitext

object → string

Return wikitext representation of argument.

Logical

not (!)

boolean → boolean

Logical 'not' operator.

and (&)

(boolean, boolean) → boolean

Logical 'and' operator. Short-circuiting: evaluates from left to right, arguments following a false value not evaluated.

or (|)

(boolean, boolean) → boolean

Logical 'or' operator. Short-circuiting: evaluates from left to right, arguments following a true value not evaluated.

xor

(boolean, boolean) → boolean

Logical 'exclusive-or' operator.

Comparison

=

(object, object) → boolean

Returns true if string representations of objects are equal, otherwise false.

!=

(object, object) → boolean

Returns false if string representations of objects are equal, otherwise true.

>

(number, number) → boolean

Returns true if first argument greater than second, otherwise false.

<

(number, number) → boolean

Returns true if first argument less than second, otherwise false.

>=

(number, number) → boolean

Returns true if first argument greater than or equal to second, otherwise false.

<=

(number, number) → boolean

Returns true if first argument less than or equal to second, otherwise false.

Math

+=

(string, number) → number

Increments value of specified identifier by specified number and returns result.

-=

(string, number) → number

Decrements value of specified identifier by specified number and returns result.

sum (+)

(number, ...) → number

Returns sum of arguments.

sub (-)

(number, number) → number

Subtracts second argument from first.

*

(number, number) → number

Multiplies arguments.

/

(number, number) → number

Divides first argument by second.

div (\)

(number, number) → number

Divides first argument by second, returns integer part of result.

mod (%)

(number, number) → number

Divides first argument by second, returns integer remainder.

pow (^)

(number, number) → number

Returns first argument raised to power of second argument.

abs

number → number

Returns absolute value of argument.

sign

number → number

Returns sign of argument.

sqrt

number → number

Returns square root of argument.

max

(number, ...) → number

Returns maximum of arguments.

min

(number, ...) → number

Returns minimum of arguments.

log

number → number

Returns logarithm to base 10 of argument.

ln

number → number

Returns natural logarithm of argument.

classify

(number, number) → string

Accepts value and interval size; returns string representation of interval of that size to which value belongs.

Strings

+

(string, string) → string

Concatenates two strings.

&=

(string, string) → string

Concatenates the value of identifier in first argument with second argument, assigns result to identifier and returns result.

contains

(string, string) → boolean

Returns true if first argument contains second, otherwise false.

lower

string → string

Returns argument transformed to lowercase.

upper

string → string

Returns argument transformed to uppercase.

lowerfirst

string → string

Returns argument with first character transformed to lowercase.

upperfirst

string → string

Returns argument with first character transformed to uppercase.

length

string → number

Returns length of argument.

empty

string → boolean

Returns true if argument is of length zero, otherwise false.

startswith

(string, string) → boolean

Returns true if first argument starts with second argument, otherwise false.

endswith

(string, string) → boolean

Returns true if first argument ends with second argument, otherwise false.

replace

(string, string, string) → string

Returns first argument with all instances of second argument replaced by third argument.

Regex

like

(string, string) → boolean

Returns true if regex pattern given by second argument matches whole of first argument, otherwise false.

match

(string, string) → string

(string, string, number) → string

With two arguments, returns first occurence of regex pattern given by second argument in first argument, or empty string if no match. With three arguments, occurence specified by third argument is returned, or empty string if there are insufficient matches.

replacepattern

(string, string, string) → string

Returns first argument with regex search pattern and replace pattern in second and third arguments applied.

Dates

date

object → date

Returns date representation of argument.

dayname

date → string

Returns name of day of week.

dayofmonth

date → number

Returns day of month.

dayofweek

date → number

Returns day of week.

dayofyear

date → number

Returns day of year.

fullday

date → string

Returns day, month name and year.

fullmonth

date → string

Returns month name and year.

fullweek

date → string

Returns week number and year.

hour

date → number

Returns hour component of argument.

minute

date → number

Returns minute component of argument.

month

date → number

Returns month number.

monthname

date → string

Returns name of month.

second

date → number

Returns second component of argument.

week

date → number

Returns week number.

year

date → number

Returns year number.

Lists

list

(object, ...) → list

Returns list constructed from arguments.

count

list → number

Returns number of items in list.

sort

list → list

Sorts argument, contents must all be of same type.

unique

list → list

Returns argument with any duplicate values removed.

group

list → table(object, number)

Returns a table listing each unique value in argument and the number of occurences.

groupby

(list, expression) → table(object, number)

Applies expression to each value in list, then applies group to results.

exclude

(list, list) → list

Returns first argument with any values that occur in second argument removed.

union

(list, list) → list

Returns list containing values from both arguments, including duplicates.

merge

(list, object) → list

Appends object in second argument to list given by first argument.

first

list → object

Returns first value in argument.

rest

list → list

Returns argument with first value removed.

last

list → object

Returns last value in argument.

item

(list, number) → object

Returns value in first argument at zero-based index given by second argument

limit

(list, number) → list

Returns number of items given by second argument from first argument, or entire list if shorter.

range

(list, number, number) → list

Returns subset of items from argument 1, of size given by argument 3 and beginning at index given by argument 2.

reverse

list → list

Returns argument with items reversed.

filter

(list, expression) → list

Evaluates expression in the context of each item in the list, returns list of items for which expression evaluates to true.

map (->)

(list, expression) → list

Evaluates expression in the context of each item in the list, returns list of results.

fold

(list, string) → object

(list, string, object) → object

Starts with third argument or default value as result and iteratively applies function given by string to next item in list. See fold (higher-order function).

movingavg

(list:list, size:number) → list

Returns list of averages of each set of size consecutive values in list. Length of resulting list is list count(list) - size + 1.

Tables

table

(list, expression, ...) → table

Evaluates each expression given in the context of each item in list and constructs a table of resulting values. Table contains one row for each item in list and one column for each expression. Parameter names given for expressions will be used as column names.

count

table → number

Returns number of rows in argument.

column

(table, number) → list

(table, string) → list

Returns list of values in table column given by column index or name.

columncount

table → number

Returns number of columns in argument.

sortby

(table, number) → table

(table, string) → table

Sorts table by column index or name.

Returns page with name given by argument.

::

(page:page, param:string) → string

Infobox lookup. Returns value of parameter param in infobox on page, with reference to parameter normalization table. Returns <no infobox> if page has no infobox, <no param> if page has an infobox but it does not contain parameter param.

assessment

page → string

Returns assessment level of page.

basename

page → string

Returns page name without namespace prefix.

creator

page → user

Returns creator of page.

firstedit

page → revision

Returns first revision of page.

hasinfobox

page → boolean

Returns true if current version of page has an infobox, otherwise false.

infobox

page → templateinstance

Returns infobox on current version of page, if any.

isarticle

page → boolean

Returns true if page is article, otherwise false.

isarticletalkpage

page → boolean

Returns true if page is article talk page, otherwise false.

isredirect

page → boolean

Returns true if current version of page is a redirect, otherwise false.

isrootpage

page → boolean

Returns true if page is not a subpage, otherwise false.

issubjectpage

page → boolean

Returns true if page is not a talk page, otherwise false.

issubpage

page → boolean

Returns true if page is a subpage, otherwise false.

istalkpage

page → booleam

Returns true if page is a talk page, otherwise false.

lastedit

page → revision

Returns most recent revision of page.

namespace

page → namespace

Returns page's namespace.

subjectpage

page → page

If page is talk page, returns equivalent subject page, otherwise returns page.

talkpage

page → page

If page is not talk page, returns equivalent talk page, otherwise returns page.

target

page → page

If page is a redirect, returns redirect target.

text

page → string

Returns text of current revision to page.

title

page → string

Returns page title.

Revisions

revision

number → revision

Returns revision with id given by argument.

author

revision → user

Returns author of revision.

change

revision → number

Returns difference in size between revision and previous revision to page.

issection

revision → boolean

Returns true if revision is section edit, otherwise false.

minor

revision → boolean

Returns true if revision is marked as minor, otherwise false.

new

revision → boolean

Returns true if revision is first revision to page, otherwise false.

page

revision → page

Returns page to which revision was made.

section

revision → string

Returns section that was edited, if any.

size

revision → number

Returns size of revision.

summary

revision → string

Returns edit summary for revision.

time

revision → date

Returns revision date/time.

tool

revision → string

Returns tool used for revision, if identifiable from summary.

Users

user

string → user

Returns user with name given by argument.

anonymous

user → boolean

Returns true if user is anonymous, otherwise false.

created

user → date

Returns date/time of account creation.

editcount

user → number

Returns number of edits user has made.

ignored

user → boolean

Returns true if user is on ignored users list, otherwise false.

name

user → string

Returns user's name.

talkpage

user → page

Returns user's talk page.

userpage

user → page

Returns user's user page.

Namespaces

namespace

number → namespace

Returns namespace with specified number.

issubjectspace

namespace → boolean

Returns true if namespace is not a talk namespace, otherwise false.

istalkspace

namespace → boolean

Returns true if namespace is a talk namespace, otherwise false.

name

namespace → string

Returns namespace name.

number

namespace → number

Returns namespace number.

subpages

namespace → boolean

Returns true if subpages are enabled in namespace, otherwise false.

List requests

Optional parameters common to all requests:

cache (boolean): Set to false to ignore any cached results.
limit (number): Maximum number of results to return. Default 1000.
namespaces (number): For requests that return pages or revisions, limit results to specified namespaces.
type (string): For requests that return pages, specify "revisions" to return info on last revision to each page, and "content" to return full text of last revision to each page.

allpages

void → list

Returns all pages.

backlinks

page → list

Returns pages that link to specified page.

contribs

user → list

Returns user's contributions.

deletedcontribs

user → list

Returns user's deleted contributions.

externallinkusage

string → list

Returns pages containing specified external link.

history

page → list

Returns revisions of specified page.

images

page → list

Returns images on specified page.

imageusage

page → list

Returns pages that use specified image.

links

page → list

Returns all internal links on specified page.

prefix

string → list

Returns pages with titles that begin with specified prefix.

subcats

category → list

Returns subcategories of specified category.

search

string → list

Returns pages that appear in search results for specified search term.

templates

page → list

Returns templates used on specified page.

transclusions

page → list

Returns pages on which specified template is used.

Statistics

pagecount

void → number

Returns total number of pages.

articlecount

void → number

Returns total number of articles.

usercount

void → number

Returns total number of user accounts.

activeusercount

void → number

Returns total number of active user accounts.

filecount

void → number

Returns total number of files.

editscount

void → number

Returns total number of revisions.

Wikitext

expand

string → string

Returns argument treated as wiki markup with any templates expanded.

strip

string → string

Returns argument with wiki links, tags and formatting removed.

paramnorm

string → string

Returns argument normalized according to parameter normalization table.

getparam

(wikitext:string, template:string, param:string) → string

Returns value of parameter param in first occurence of template in wikitext.

setparam

(wikitext:string, template:string, param:string, value:string) → boolean

Returns wikitext with parameter param in first occurence of template set to value. Treats any template that redirects to template as an instance of such. Replaces parameter value if it already exists, otherwise adds it. Does nothing if no instance of template is found. Returns true if parameter was set, otherwise false.

addcategory

(wikitext:string, category:string) → string

Returns wikitext with category added. Does not add category if already present.

removecategory

(wikitext:string, category:string) → string

Returns wikitext with category removed, or no change if category not present.

replacecategory

(wikitext:string, category:string, replacement:string) → string

Returns wikitext with category replaced with replacement, or no change if not present.

removetemplate

(wikitext:string, template:string) → string

Returns wikitext with first occurence of template removed, or no change if no instance of template present. Treats any template that redirects to template as an instance of such.

Actions

edit

(page:page, wikitext:string, summary:string) → string

Edits page specified by page, using wikitext as text and summary as edit summary.

Optional arguments:

section - string. Edit this section. Should be number or "new".
minor - boolean. Whether to mark as minor edit. Defaults to true.
bot - boolean. Whether to mark as bot edit. Defaults to true if account is in bot group, has no effect if not.
create - boolean. Whether to create page if it does not exist. Defaults to true.
conflict - string. Behaviour in event of edit conflict. One of the following values. Default is ignore.
- abort - Give up and move on.
- retry - Try again. When adding section or prepending/appending text, applies changes on top of conflicted edit. Will overwrite conflicted edit in other cases.
- prompt - Ask whether to save anyway.
- ignore - Don't bother checking for conflicts in the first place.