@uttori/storage-provider-json-memory/dist/where-parser.d.ts

Uttori storage provider using JavaScript objects in memory.

export default SqlWhereParser;
export type SqlWhereParserConfig = {
    /**
     * A collection of operators in precedence order.
     */
    operators: Record<string | number | symbol, number | symbol>[];
    /**
     * A Tokenizer config.
     */
    tokenizer: import('./tokenizer.js').TokenizeThisConfig;
    /**
     * Wraps queries in surround parentheses when true.
     */
    wrapQuery: boolean;
};
/**
 * @typedef {object} SqlWhereParserConfig
 * @property {Record<string | number | symbol, number | symbol>[]} operators A collection of operators in precedence order.
 * @property {import('./tokenizer.js').TokenizeThisConfig} tokenizer A Tokenizer config.
 * @property {boolean} wrapQuery Wraps queries in surround parentheses when true.
 */
/**
 * Parses the WHERE portion of an SQL-like string into an abstract syntax tree.
 * The tree is object-based, where each key is the operator, and its value is an array of the operands.
 * The number of operands depends on if the operation is defined as unary, binary, or ternary in the config.
 * @property {SqlWhereParserConfig} config The configuration object.
 * @property {import('./tokenizer.js').TokenizeThis} tokenizer The tokenizer instance.
 * @property {object} operators The operators from config converted to Operator objects.
 * @example <caption>Init SqlWhereParser</caption>
 * const parser = new SqlWhereParser();
 * const parsed = parser.parse(sql);
 * @class
 */
declare class SqlWhereParser {
    /**
     * A default fallback evaluator for the parse function.
     * @param {string|symbol} operatorValue - The operator to evaluate.
     * @param {string[]} operands - The list of operands.
     * @returns {Array<string | number | import('../dist/custom.js').SqlWhereParserAst>|import('../dist/custom.js').SqlWhereParserAst} Either comma seperated values concated, or an object with the key of the operator and operands as the value.
     */
    static defaultEvaluator: (operatorValue: string | symbol, operands: string[]) => Array<string | number | import('../dist/custom.js').SqlWhereParserAst> | import('../dist/custom.js').SqlWhereParserAst;
    /**
     * Creates an instance of SqlWhereParser.
     * @param {SqlWhereParserConfig} [config] - A configuration object.
     * @class
     */
    constructor(config?: SqlWhereParserConfig);
    /** @type {import('./tokenizer.js').TokenizeThis} Tokenizer instance. */
    tokenizer: import('./tokenizer.js').TokenizeThis;
    /** @type {Record<string | symbol, Operator>} The operators from config converted to Operator objects. */
    operators: Record<string | symbol, Operator>;
    config: SqlWhereParserConfig;
    /**
     * Parse a SQL statement with an evaluator function. Uses an implementation of the Shunting-Yard Algorithm.
     * @param {string} sql - Query string to process.
     * @param {(operatorValue: string | symbol, operands: string[]) => Array<string | number | import('../dist/custom.js').SqlWhereParserAst>|import('../dist/custom.js').SqlWhereParserAst} [evaluator] - Function to evaluate operators.
     * @returns {import('../dist/custom.js').SqlWhereParserAst} - The parsed query tree.
     * @see {@link https://wcipeg.com/wiki/Shunting_yard_algorithm|Shunting-Yard_Algorithm (P3G)}
     * @see {@link https://en.wikipedia.org/wiki/Shunting-yard_algorithm|Shunting-Yard_Algorithm (Wikipedia)}
     */
    parse: (sql: string, evaluator?: (operatorValue: string | symbol, operands: string[]) => Array<string | number | import('../dist/custom.js').SqlWhereParserAst> | import('../dist/custom.js').SqlWhereParserAst) => import('../dist/custom.js').SqlWhereParserAst;
    /**
     * Returns the precedence order from two values.
     * @param {string|symbol} operatorValue1 - First operator.
     * @param {string|symbol} operatorValue2 - Second operator.
     * @returns {boolean} That operatorValue2 precedence is less than or equal to the precedence of operatorValue1.
     */
    operatorPrecedenceFromValues: (operatorValue1: string | symbol, operatorValue2: string | symbol) => boolean;
    /**
     * Returns the operator from the string or Symbol provided.
     * @param {string|symbol} operatorValue - The operator.
     * @returns {*} The operator from the list of operators.
     */
    getOperator: (operatorValue: string | symbol) => any;
}
import Operator from './operator.js';
//# sourceMappingURL=where-parser.d.ts.map