Home Contents | # string.match | String | Lua Commands

## SYNOPSIS

string.match(s,pattern[,init])

## DESCRIPTION

Looks for the first match of pattern in the string s. If it finds one, then match returns the captures from the pattern; otherwise it returns nil. If pattern specifies no captures, then the whole match is returned. A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative.

## RETURN VALUE

Returns a string or nil.

## EXAMPLE

>
print(string.match("test","te"))
te