vrack-db/lib/Errors/CoreError.js

This is an In Memory database designed for storing time series (graphs).

"use strict";
/*
 * Copyright © 2024 Boris Bobylev. All rights reserved.
 * Licensed under the Apache License, Version 2.0
*/
Object.defineProperty(exports, "__esModule", { value: true });
/**
 * Base class for error realization with the ability to
 * import and export error classes for client-server operations.
 *
 * In VRack, a lot of things are transmitted over the network as JSON.
 * Since pure errors are not converted to JSON, methods were made to export and
 * import them while preserving the main important properties.
 *
 * If the imported error has properties that are not in the base class,
 * they will be added. To get unknown properties you can use the function
 * (for typescript) getUnknownProperty.
 *
*/
class CoreError extends Error {
    constructor(name, message, code, short) {
        super(message);
        /** Flag that the error belongs to VRack */
        this.vError = true;
        /** Error code */
        this.vCode = "";
        /** Short code */
        this.vShort = "";
        /** List of additional parameters */
        this.vAdd = [];
        /** Nested errors */
        this.vAddErrors = [];
        this.name = name;
        this.vCode = code;
        this.vShort = short;
    }
    /**
     * Imports an error that came over the network as a JSON object
     * Uses objectify for the incoming object just in case
     *
     * @returns {CoreError} this после модификации
    */
    import(error) {
        const objectifyError = CoreError.objectify(error);
        Object.assign(this, objectifyError);
        return this;
    }
    /**
     * Returns an object to be transmitted over the network
     * with preliminary conversion to JSON
    */
    export() {
        return CoreError.objectify(this);
    }
    /**
     * Add nested error
     *
     * @param err Nested error
    */
    add(err) {
        this.vAddErrors.push(CoreError.objectify(err));
        return this;
    }
    /**
     * For Typescript it is used to retrieve an unknown
     * instance property after importing an incoming error
    */
    getUnknownProperty(field) {
        const dynamicKey = field;
        return this[dynamicKey];
    }
    /**
     *  Returns an object to be transmitted over the network
     *
     * @param {any} error Error for conversion to an object
     * */
    static objectify(error) {
        const result = {};
        for (const key of Object.getOwnPropertyNames(error))
            result[key] = error[key];
        return result;
    }
}
exports.default = CoreError;