Literal Toolkit
A toolkit to parse and generate JavaScript style literals.
In case to write a pseudo code implementation or data structure, this toolkit
will help a lot on parsing and generating strings, numbers, regular expressions,
keyword values, and even comments.
Install
$ npm i literal-toolkit
API
There are several interfaces under this package, each of them have the similar
functions that can be used to parse and generate literals.
All parseToken()
functions, when the given string cannot be parsed, will
return null
by default.
All parse()
functions are short-cuts of parseToken(str).value
(might include
additional features). All these functions, when the given string cannot be
parsed, will return undefined
instead.
All parse()
functions are just for simple parsing usage, when dealing with
complex scenarios, use parseToken()
instead.
For detailed API documentation, please redirect to interface declarations.
Usage
import { string, number, keyword, regexp, comment } from "literal-toolkit";
string.parse('"this is a double-quoted string literal"');
string.parse("'this is a single-quoted string literal'");
string.parse("`this is a back-quoted\n and multi-line string`");
number.parse("1234567");
number.parse("0b1010101");
number.parse("0o1234567");
number.parse("01234567");
number.parse("0x1234567");
keyword.parse("true");
keyword.parse("false");
keyword.parse("null");
keyword.parse("NaN");
keyword.parse("Infinity");
regexp.parse("/[a-zA-Z0-9]/i");
comment.parse("// this is a single-line comment");
comment.parse("/* this is a inline comment */");
comment.parse("/* this comment contains\n multiple\n lines */");
comment.parse("/** this is a JSDoc comment */");
This toolkit is meant to parse any valid JavaScript literal strings (of
supported types) into real values, so any form that works in JavaScript syntax
can be parsed by this package, although the above example doesn't cover that
much. Check the test for more examples.