Module: mona/strings

Methods

alpha()

Returns a parser that matches a single non-unicode alphabetical character.

Source:

• mona.js, line 1041

Example

parse(alpha(), "a"); // => "a"
parse(alpha(), "A"); // => "A"

alphaLower()

Returns a parser that matches a single non-unicode lowercase alphabetical character.

Source:

• mona.js, line 1027

Example

parse(alphaLower(), "d"); // => "d"

alphanum(base)

Returns a parser that matches an alphanumeric character.

Parameters:

Name	Type	Argument	Default	Description
base	Integer	<optional>	10	Optional base for numeric parsing.

Source:

• mona.js, line 1073

Example

parse(alphanum(), "1"); // => "1"
parse(alphanum(), "a"); // => "a"
parse(alphanum(), "A"); // => "A"

alphaUpper()

Returns a parser that matches a single non-unicode uppercase alphabetical character.

Source:

• mona.js, line 1013

Example

parse(alphaUpper(), "D"); // => "D"

digit(base)

Returns a parser that parses a single digit character token from the input.

Parameters:

Name	Type	Argument	Default	Description
base	Integer	<optional>	10	Optional base for the digit.

Source:

• mona.js, line 1055

Example

parse(digit(), "5"); // => "5"

noneOf(matches, caseSensitive, parser)

Returns a parser that fails if the next token or string matches one of the given inputs. If the third parser argument is given, that parser will be used to collect the actual value of noneOf.

Parameters:

Name	Type	Argument	Default	Description
matches	String | Array			Characters or strings to match. If this argument is a string, it will be treated as if matches.split("") were passed in.
caseSensitive	Boolean	<optional>	true	Whether to match char case exactly.
parser	Parser	<optional>	token()	What to actually parse if none of the given matches succeed.

Source:

• mona.js, line 970

Example

parse(noneOf("abc"), "d"); // => "d"
parse(noneOf(["foo", "bar", "baz"]), "frob"); // => "f"
parse(noneOf(["foo", "bar", "baz"], true, text()), "frob"); // => "frob"

oneOf(matches, caseSensitive)

Returns a parser that succeeds if the next token or string matches one of the given inputs.

Parameters:

Name	Type	Argument	Default	Description
matches	String | Array			Characters or strings to match. If this argument is a string, it will be treated as if matches.split("") were passed in.
caseSensitive	Boolean	<optional>	true	Whether to match char case exactly.

Source:

• mona.js, line 943

Example

parse(oneOf("abcd"), "c"); // => "c"
parse(oneOf(["foo", "bar", "baz"]), "bar"); // => "bar"

space()

Returns a parser that matches one whitespace character.

Source:

• mona.js, line 1086

Example

parse(space(), "\r"); // => "\r"

spaces()

Returns a parser that matches one or more whitespace characters. Returns a single space character as its result, regardless of which whitespace characters were matched.

Source:

• mona.js, line 1101

Example

parse(spaces(), "   \r\n\t \r \n"); // => " "

string(str, caseSensitive)

Returns a parser that succeeds if str matches the next str.length inputs, consuming the string and returning it as a value.

Parameters:

Name	Type	Argument	Default	Description
str	String			String to match against.
caseSensitive	Boolean	<optional>	true	Whether to match char case exactly.

Source:

• mona.js, line 990

Example

parse(string("foo"), "foo"); // => "foo"

stringOf(parser)

Returns a string containing the concatenated results returned by applying parser. parser must be a combinator that returns an array of string parse results.

Parameters:

Name	Type	Description
parser	Parser	Parser that results in an array of strings.

Source:

• mona.js, line 917

Example

parse(stringOf(collect(token())), "aaa"); // => "aaa"

text(parser, opts)

Returns a parser that collects between min and max tokens matching parser. The result is returned as a single string. This parser is essentially collect() for strings.

Parameters:

Name	Type	Argument	Default	Description
parser	Parser	<optional>	token()	Parser to use to collect the results.
opts	Object	<optional>		Properties Name Type Argument Default Description min Integer <optional> 0 Minimum number of matches. max Integer <optional> Infinity Maximum number of matches.

Source:

• mona.js, line 1121

Example

parse(text(), "abcde"); // => "abcde"
parse(text(noneOf("a")), "bcde"); // => "bcde"

trim(parser)

Returns a parser that trims any whitespace surrounding parser.

Parameters:

Name	Type	Description
parser	Parser	Parser to match after cleaning up whitespace.

Source:

• mona.js, line 1137

Example

parse(trim(token()), "    \r\n  a   \t"); // => "a"

trimLeft(parser)

Returns a parser that trims any leading whitespace before parser.

Parameters:

Name	Type	Description
parser	Parser	Parser to match after cleaning up whitespace.

Source:

• mona.js, line 1153

Example

parse(trimLeft(token()), "    \r\n  a"); // => "a"

trimRight(parser)

Returns a parser that trims any trailing whitespace before parser.

Parameters:

Name	Type	Description
parser	Parser	Parser to match after cleaning up whitespace.

Source:

• mona.js, line 1167

Example

parse(trimRight(token()), "a   \r\n"); // => "a"