diff options
Diffstat (limited to 'deps/acorn-plugins/acorn-bigint/README.md')
| -rw-r--r-- | deps/acorn-plugins/acorn-bigint/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/deps/acorn-plugins/acorn-bigint/README.md b/deps/acorn-plugins/acorn-bigint/README.md new file mode 100644 index 0000000000..b0b6bb5554 --- /dev/null +++ b/deps/acorn-plugins/acorn-bigint/README.md @@ -0,0 +1,21 @@ +# BigInt support for Acorn + +[](https://www.npmjs.org/package/acorn-bigint) + +This is a plugin for [Acorn](http://marijnhaverbeke.nl/acorn/) - a tiny, fast JavaScript parser, written completely in JavaScript. + +It implements support for arbitrary precision integers as defined in the stage 3 proposal [BigInt: Arbitrary precision integers in JavaScript](https://github.com/tc39/proposal-bigint). The emitted AST follows [an ESTree proposal](https://github.com/estree/estree/blob/132be9b9ec376adbc082dd5f6ba78aefd7a1a864/experimental/bigint.md). + +## Usage + +This module provides a plugin that can be used to extend the Acorn `Parser` class: + +```javascript +const {Parser} = require('acorn'); +const bigInt = require('acorn-bigint'); +Parser.extend(bigInt).parse('100n'); +``` + +## License + +This plugin is released under an [MIT License](./LICENSE). |