@neo4j/cypher-builder/dist/expressions/operations/math.js

A programmatic API for building Cypher queries for Neo4j

"use strict";
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.MathOp = void 0;
exports.plus = plus;
exports.minus = minus;
exports.multiply = multiply;
exports.divide = divide;
exports.mod = mod;
exports.pow = pow;
const CypherASTNode_1 = require("../../CypherASTNode");
/**
 * @group Operators
 * @category Math
 */
class MathOp extends CypherASTNode_1.CypherASTNode {
    /** @internal */
    constructor(operator, exprs) {
        super();
        this.operator = operator;
        this.exprs = exprs;
    }
    /**
     * @internal
     */
    getCypher(env) {
        const exprs = this.exprs.map((e) => e.getCypher(env));
        const operatorStr = ` ${this.operator} `;
        return `(${exprs.join(operatorStr)})`;
    }
}
exports.MathOp = MathOp;
function createOp(op, exprs) {
    return new MathOp(op, exprs);
}
function plus(...exprs) {
    return createOp("+", exprs);
}
/**
 * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation}
 * @group Operators
 * @category Math
 */
function minus(leftExpr, rightExpr) {
    return createOp("-", [leftExpr, rightExpr]);
}
/**
 * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation}
 * @group Operators
 * @category Math
 */
function multiply(leftExpr, rightExpr) {
    return createOp("*", [leftExpr, rightExpr]);
}
/**
 * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation}
 * @group Operators
 * @category Math
 */
function divide(leftExpr, rightExpr) {
    return createOp("/", [leftExpr, rightExpr]);
}
/** Modulus (%) operator
 * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation}
 * @group Operators
 * @category Math
 */
function mod(leftExpr, rightExpr) {
    return createOp("%", [leftExpr, rightExpr]);
}
/** Power (^) operator
 * @see {@link https://neo4j.com/docs/cypher-manual/current/syntax/operators/#query-operators-mathematical | Cypher Documentation}
 * @group Operators
 * @category Math
 */
function pow(leftExpr, rightExpr) {
    return createOp("^", [leftExpr, rightExpr]);
}