Skip to content

Fix example in README.md #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lydell merged 2 commits into from
Dec 8, 2025
+3 −3
Merged

Fix example in README.md #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
56c7cb7
Fix example in README.md
fisker Dec 8, 2025
e7c70dd
Update js-tokens usage in README examples
fisker Dec 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The tiny, regex powered, lenient, _almost_ spec-compliant JavaScript tokenizer that never fails.

```js
const jsTokens = require("js-tokens");
import jsTokens from "js-tokens";

const jsString = 'JSON.stringify({k:3.14**2}, null /*replacer*/, "\\t")';

Expand Down Expand Up @@ -601,15 +601,15 @@ js-tokens advertises that it “never fails”. Tell you what, it _can_ fail on
For example, if you try to parse the string literal `"\n\n\n"` but with 10 million `\n` instead of just 3, the regex engine gives up with `RangeError: Maximum call stack size exceeded` (or similar). Try it out:

```js
Array.from(require("js-tokens")(`"${"\\n".repeat(1e7)}"`));
Array.from(jsTokens(`"${"\\n".repeat(1e7)}"`));
```

(Yes, that is the _regex engine_ of the runtime giving up. js-tokens has no recursive functions.)

However, if you repeat `a` instead of `\n` 10 million times (`"aaaaaa…"`), it works:

```js
Array.from(require("js-tokens")(`"${"a".repeat(1e7)}"`));
Array.from(jsTokens(`"${"a".repeat(1e7)}"`));
```

That’s good, because it’s much more common to have lots of non-escapes in a row in a big string literal, than having mostly escapes. (Obfuscated code might have _only_ escapes though.)
Expand Down