Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@rsql/parser

piotr-oles30.8kMIT1.6.0TypeScript support: included

RSQL Parser

rsql, fiql, parser

readme

@rsql/parser

RSQL parser for Node.js and Browsers

npm lerna code style: prettier commitizen friendly tested with jest auto release

Installation

# with npm
npm install --save @rsql/parser

# with yarn
yarn add @rsql/parser

API

parse(source: string): ExpressionNode

Parses RSQL string and returns Abstract Syntax Tree. It can throw the following errors:

  • TypeError - in the case of invalid argument type passed to the parse function
  • SyntaxError - in the case of any problems encountered during parsing

License

MIT

changelog

v1.0.2 (Thu Oct 08 2020)

🐛 Bug Fix

Authors: 1


v1.0.0 (Sun May 10 2020)

💥 Breaking Change

🚀 Enhancement

  • feat: add support for custom comparison operators (@piotr-oles)
  • feat: general improvements and documentation (@piotr-oles)
  • feat: implement initial version of the RSQL parser (@piotr-oles)

🐛 Bug Fix

Authors: 1