{"bugs":{"url":"https://github.com/un-ts/toml-tools/issues"},"dist":{"shasum":"94e5606e0ee776f279f091dbfbf39e6c7ae81218","tarball":"https://registry.npmjs.org/@toml-tools/lexer/-/lexer-1.0.1.tgz","fileCount":7,"integrity":"sha512-jn2fl8m/9QPcUD507Hbt2W3TVMKzF5HEY8xKIxqY2r2dTG2udeCKlo2ejJ5k/RSOJsWNIuw+Ir/nxW5PItUApA==","signatures":[{"sig":"MEYCIQCDXTmOac2B1/glB5ycuQsoxnQo3IPf5yQu4KUZxfLjLQIhAI0d8beheJLvLN3A425aE/F/rmb0dT60CTzOq5Tv+Dir","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11303},"main":"lib/api.js","name":"@toml-tools/lexer","type":"module","types":"./api.d.ts","readme":"[![npm](https://img.shields.io/npm/v/@toml-tools/lexer.svg)](https://www.npmjs.com/package/@toml-tools/lexer)\n\n# TOML-Tools/lexer\n\nA Toml Lexer implemented in JavaScript using the [Chevrotain](https://github.com/SAP/chevrotain) Parsing Toolkit.\n\nThis package could be used as part of a Toml Parser,\na Toml syntax highlighter or any other use case where a Toml **Token Vector** would be useful.\n\n## Installation\n\n```bash\nyarn add @toml-tools/lexer\n# or if you prefer npm\nnpm install @toml-tools/lexer\n```\n\n## APIs\n\nThis package's [APIs](./api.d.ts) are exported as a TypeScript definition file.\n\n## Usage\n\n```javascript\nconst { tokenize } = require(\"@toml-tools/lexer\");\n\nconst input = `# This is a TOML document.\ntitle = \"TOML Example\"\n`;\n// Tokenize returns a Chevrotain IlexingResult\n// - https://sap.github.io/chevrotain/documentation/4_2_0/interfaces/ilexingresult.html\nconst lexingResult = tokenize(input);\nconsole.log(lexingResult.errors.length); // 0\nconsole.log(lexingResult.tokens.length); // 6\nconst tokens = lexingResult.tokens;\n// Each Token is a Chevrotain Itoken\n//  - https://sap.github.io/chevrotain/documentation/4_2_0/interfaces/itoken.html\nconsole.log(tokens[0].image); // \"# This is a TOML document.\"\nconsole.log(tokens[0].startLine); // 1\nconsole.log(tokens[0].endOffset); // 26\n// ...\n```\n","exports":{".":{"types":"./api.d.ts","default":"./lib/api.js"},"./package.json":"./package.json"},"gitHead":"d7dfe8f919e0fde556e35d70f216a40cb41f8497","license":"MIT","scripts":{"test":"mocha ./test/*spec.js"},"_npmUser":{"name":"jounqin","email":"admin@1stg.me"},"homepage":"https://github.com/un-ts/toml-tools/tree/master#readme","keywords":["toml","lexer"],"repository":{"url":"git+https://github.com/un-ts/toml-tools.git#master","type":"git"},"_npmVersion":"8.19.4","description":"TOML Lexer Implemented in JavaScript","directories":{},"maintainers":[{"name":"jounqin","email":"admin@1stg.me"},{"name":"bd82","email":"shahars@protonmail.com"}],"_nodeVersion":"16.20.2","dependencies":{"chevrotain":"^11.0.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/lexer_1.0.1_1707757498628_0.2871582395247678","host":"s3://npm-registry-packages"},"_id":"@toml-tools/lexer@1.0.1","version":"1.0.1"}