@iredium/butterfly/lib/controllers/api_controller.d.ts

Express API Framework

import { Class } from '../types/class';
import { BaseResponse } from '../routes/responses/base_response';
import { BaseController } from './base_controller';
export declare class ApiController extends BaseController {
    constructor(ServiceClass: Class, PolicyClass: Class);
    /**
     * Get a collection of Models.
     * @returns A Promise, an exception or a value.
     */
    index(req: any): Promise<BaseResponse>;
    /**
     * Get a Model by id.
     * @param req an express's request object.
     * @returns A Promise, an exception or a value.
     */
    show(req: any, record: any): Promise<BaseResponse>;
    /**
     * Create a Model.
     * @param req an express's request object.
     * @returns A Promise, an exception or a value.
     */
    create(req: any): Promise<BaseResponse>;
    /**
     * Update a Model.
     * @param req an express's request object.
     * @returns A Promise, an exception or a value.
     */
    update(req: any, record: any): Promise<BaseResponse>;
    /**
     * Delete a Model.
     * @param req an express's request object.
     * @returns A Promise, an exception or a value.
     */
    destroy(req: any, record: any): Promise<BaseResponse>;
    /**
     * Restore a deleted Model.
     * @param req an express's request object.
     * @returns A Promise, an exception or a value.
     */
    restore(req: any, record: any): Promise<BaseResponse>;
    protected getDefaultIndexQuery(): object;
}