@rsql/parser

@rsql/parser

RSQL parser for Node.js and Browsers

⚠️ WARNING: This package is still in development - API may break compatibility without upgrading major version! ⚠️

Installation

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

# with yarn
yarn add @rsql/parser

API

parse(rsql: string): ExpressionNode

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

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

new ParsingError(message: string, source: string)

A runtime error that should be thrown in the case of encountering any problem with the parsing (invalid character, invalid token, etc.)

Example

import { parse, ParsingError } from "@rsql/parser";
import { isEqNode, getSingleValue } from "@rsql/ast";

function getUserNameFromRsql(rsql) {
  let ast;

  try {
    ast = parse(rsql);
  } catch (error) {
    if (error instanceof ParsingError) {
      return undefined;
    } else {
      throw error;
    }
  }

  if (isEqNode(ast) && getSelector(ast) === "user.name") {
    return getSingleValue(ast);
  } else {
    return undefined;
  }
}

License

MIT