@mysql/xdevapi/types/lib/DevAPI/BaseResult.d.ts

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

/*
 * Copyright (c) 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
 */

/**
 * Additional constants part of the Warning type.
 */
export namespace Warning {
    /**
     * Type of server-side warning.
     */
    export const enum Level {
        NOTE = 1,
        WARNING = 2,
        ERROR = 3
    }
}

/**
 * Object containing details about a MySQL server warning.
 * ```
 * interface Warning {
 *   level: number,
 *   code: number,
 *   msg: string
 * }
 * ```
 */
export interface Warning {
    /**
     * The type of warning as defined by `Warning.Level.*`.
     * @defaultValue `Warning.Level.WARNING`
     */
    level: Warning.Level
    /**
     * The numeric warning code.
     */
    code?: number
    /**
     * The warning message itself.
     */
    msg: string
}

interface BaseResult {
    /**
     * Retrieves the list of warnings generated by a statement.
     * @returns An array containing objects with the details of each
     * warning generated by the statement.
     */
    getWarnings: () => Warning[]
    /**
     * Retrieves the number of warnings generated by a statement.
     * @returns The total number of warnings generated by the statement.
     */
    getWarningsCount: () => number
}

export default BaseResult;