@mysql/xdevapi/lib/Protocol/Wrappers/Messages/Crud/Limit.js

MySQL Connector/Node.js - A Node.js driver for MySQL using the X Protocol and X DevAPI.

/*
 * Copyright (c) 2020, 2022, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2.0, as
 * published by the Free Software Foundation.
 *
 * This program is also distributed with certain software (including
 * but not limited to OpenSSL) that is licensed under separate terms,
 * as designated in a particular file or component or in included license
 * documentation.  The authors of MySQL hereby grant you an
 * additional permission to link the program and your derivative works
 * with the separately licensed software that they have included with
 * MySQL.
 *
 * Without limiting anything contained in the foregoing, this file,
 * which is part of MySQL Connector/Node.js, is also subject to the
 * Universal FOSS Exception, version 1.0, a copy of which can be found at
 * http://oss.oracle.com/licenses/universal-foss-exception.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License, version 2.0, for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 */

'use strict';

const LimitStub = require('../../../Stubs/mysqlx_crud_pb').Limit;
const wraps = require('../../Traits/Wraps');

/**
 * @private
 * @alias module:adapters.Mysqlx.Crud.Limit
 * @param {proto.Mysqlx.Crud.Limit} proto - protobuf stub
 * @returns {module:adapters.Mysqlx.Crud.Limit}
 */
function Limit (proto) {
    return Object.assign({}, wraps(proto), {
        /**
         * Serialize to JSON using a protobuf-like convention.
         * @function
         * @name module:adapters.Mysqlx.Crud.Limit#toJSON
         * @returns {Object} The JSON representation
         */
        toJSON () {
            // Mysqlx.Crud.Limit and Mysqlx.Crud.LimitExpr are exclusive which
            // means one of them will be undefined.
            if (typeof proto === 'undefined') {
                // In that case, we want the field to be ignored in the parent object.
                return;
            }

            return {
                // With the "[jstype = JS_STRING]" hint enabled, both the
                // "row_count" and "offset" fields contain a string.
                // This ensures that unsafe values (which cannot be represented as
                // JavaScript numbers) do not lose precision.
                // In the client side, those values can always be converted to
                // BigInt.
                row_count: BigInt(proto.getRowCount()),
                offset: BigInt(proto.getOffset())
            };
        }
    });
}

/**
 * Creates a wrapper for a Mysqlx.Crud.Limit protobuf message given a count
 * and, additionally, an offset.
 * @private
 * @param {number} [count]
 * @param {number} [offset]
 * @returns {module:adapters.Mysqlx.Crud.Limit}
 */
Limit.create = function ({ count, offset } = {}) {
    // If the count is not defined there's nothing to do.
    // We can't wrap an empty Mysqlx.Crud.Limit stub instance because it
    // contains a default value of 0 for count, and that is not the
    // intended behaviour.
    if (typeof count === 'undefined') {
        return Limit();
    }

    const proto = new LimitStub();

    // "count" is required and can be either a number, a string or a bigint.
    // so, it is always converted to a string.
    proto.setRowCount(count.toString());

    // "offset" is optional and can also be either a number, a string or a
    // bigint.
    if (typeof offset !== 'undefined') {
        proto.setOffset(offset.toString());
    }

    return Limit(proto);
};

module.exports = Limit;