@mysql/xdevapi/lib/DevAPI/BaseResult.js

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

/*
 * Copyright (c) 2018, 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';

/**
 * BaseResult common API of the resultset interface.
 * @module BaseResult
 */

/**
 * @private
 * @alias module:BaseResult
 * @param {Array<Warning>} [warnings] - The list of warnings generated by the
 * statement.
 * @returns {module:BaseResult}
 */
function BaseResult ({ warnings = [] } = {}) {
    return {
        /**
         * MySQL Warning
         * @typedef {Object} Warning
         * @prop {Number} level Warning level (1 - NOTE, 2 - WARNING, 3 - ERROR)
         * @prop {Number} code Warning code in the server
         * @prop {string} msg Warning message
         */

        /**
         * Retrieve the list of warnings generated on the server.
         * @function
         * @name module:BaseResult#getWarnings
         * @returns {Array.<Warning>} The list of warning objects
         */
        getWarnings () {
            return warnings;
        },

        /**
         * Retrieve the number of warnings generated on the server.
         * @function
         * @name module:BaseResult#getWarningsCount
         * @returns {number} The number of warnings.
         */
        getWarningsCount () {
            return warnings.length;
        }
    };
}

module.exports = BaseResult;