lemon-core/dist/controllers/dummy-controller.d.ts

Lemon Serverless Micro-Service Platform

import { NextHandler, NextMode } from 'lemon-model';
import { DummyDynamoService } from '../cores/dynamo/';
import { GeneralController } from './general-controller';
/** ********************************************************************************************************************
 *  MAIN IMPLEMENTATION.
 ** ********************************************************************************************************************/
/**
 * class: `DummyController`
 * - to serve basic CRUD with `dummy-<type>-data.yml`
 */
export declare class DummyController extends GeneralController {
    protected _name: string;
    protected service: DummyDynamoService<any>;
    /**
     * create dummy-controller with type
     *
     * @param type      type of resource
     * @param name      name of dummy data (default equal to type)
     * @param idName    name of id (default as 'id')
     */
    constructor(type: string, name?: string, idName?: string);
    /**
     * name of this resource.
     */
    hello: () => string;
    /**
     * decode to target `next-handler`
     * - use pattern `do_<mode>_<cmd?>`
     */
    decode(mode: NextMode, id: string, cmd: string): any;
    /**
     * get list of data.
     */
    do_list: NextHandler;
    /**
     * read item.
     */
    do_get: NextHandler;
    /**
     * update item.
     */
    do_put: NextHandler;
    /**
     * save item.
     */
    do_post: NextHandler;
    /**
     * delete item.
     */
    do_delete: NextHandler;
}