@foal/cli/lib/commands/generators/create-rest-api/create-rest-api-command.service.d.ts

CLI tool for FoalTS

import { Generator } from '../../../services';
/**
 * Service for creating a new REST API endpoint (entity and controller).
 */
export declare class CreateRestApiCommandService {
    private generator;
    constructor(generator: Generator);
    /**
     * Create a new REST API endpoint (entity and controller).
     *
     * @param {string} name - The name of the REST API endpoint
     * @param {boolean} register - Whether to register the controller in app.controller.ts
     * @param {boolean} auth - Whether to include authentication/authorization
     * @returns {void}
     */
    run({ name, register, auth }: {
        name: string;
        register: boolean;
        auth?: boolean;
    }): void;
}