@teqfw/core/src/Back/Api/Dto/Command/Argument.mjs

Core functionalities for plugin scanning, local configuration management, and command-line utilities for building modern web applications with the Tequila Framework.

/**
 * Data structure for command argument.
 * (@see node_modules/commander/lib/command.js:291 - Command.argument)
 */
// MODULE'S VARS
const NS = 'TeqFw_Core_Back_Api_Dto_Command_Argument';

// MODULE'S CLASSES
export default class TeqFw_Core_Back_Api_Dto_Command_Argument {
    /** @type {*} */
    defaultValue;
    /** @type {string} */
    description;
    /** @type {Function|*} */
    fn;
    /** @type {string} */
    name;
}

/**
 * Factory to create new DTO instances.
 * @memberOf TeqFw_Core_Back_Api_Dto_Command_Argument
 */
export class Factory {
    static namespace = NS;

    /**
     * @param {TeqFw_Core_Shared_Util_Cast} cast
     */
    constructor(
        {
            TeqFw_Core_Shared_Util_Cast$: cast,
        }
    ) {
        // INSTANCE METHODS
        /**
         * @param {TeqFw_Core_Back_Api_Dto_Command_Argument|null} data
         * @returns {TeqFw_Core_Back_Api_Dto_Command_Argument}
         */
        this.create = function (data = null) {
            const res = new TeqFw_Core_Back_Api_Dto_Command_Argument();
            res.defaultValue = (typeof data?.defaultValue === 'object')
                ? JSON.parse(JSON.stringify(data.defaultValue)) // make a copy
                : cast.string(data.defaultValue);
            res.description = cast.string(data?.description);
            res.fn = cast.function(data?.fn);
            res.name = cast.string(data?.name);
            return res;
        }
    }
}