Class DummyController

class: DummyController

to serve basic CRUD with dummy-<type>-data.yml

Hierarchy

GeneralController
- DummyController

Index

Constructors

Properties

TYPE _name do_delete do_get do_list do_post do_put service

Methods

asFuncName asFuncNameByDo decode hello type

Constructors

constructor

new DummyController(type: string, name?: string, idName?: string): DummyController
create dummy-controller with type
Parameters
- type: string
  
  type of resource
- Optional name: string
  
  name of dummy data (default equal to type)
- idName: string = 'id'
  
  name of id (default as 'id')
Returns DummyController
Overrides GeneralController.constructor
- Defined in src/controllers/dummy-controller.ts:39

Properties

`Readonly` TYPE

TYPE: string

resource type of this Controller.

`Protected` _name

_name: string

do_delete

do_delete: NextHandler<any, any, any> = ...

delete item.

do_get

do_get: NextHandler<any, any, any> = ...

read item.

do_list

do_list: NextHandler<any, any, any> = ...

get list of data.

do_post

do_post: NextHandler<any, any, any> = ...

save item.

do_put

do_put: NextHandler<any, any, any> = ...

update item.

`Protected` service

service: DummyDynamoService<any>

Methods

asFuncName

asFuncName(mode: string, type?: string, cmd?: string): string
translate to camel styled method name from mode + cmd ex: GET /0/hi -> getHelloHi ex: GET /0/say-me -> getHelloSayMe
Parameters
- mode: string
- Optional type: string
- Optional cmd: string
Returns string
Inherited from GeneralController.asFuncName
- Defined in src/controllers/general-controller.ts:72

asFuncNameByDo

asFuncNameByDo(mode: string, type?: string, cmd?: string): string
translate to camel styled function name like doGetHello()

ex: GET / -> doList ex: GET /0/hi -> doGetHi ex: POST /0/say-me -> doPostSayMe
Parameters
- mode: string
- Optional type: string
- Optional cmd: string
Returns string
Inherited from GeneralController.asFuncNameByDo
- Defined in src/controllers/general-controller.ts:88

decode

decode(mode: NextMode, id: string, cmd: string): any
decode to target next-handler
- use pattern do_<mode>_<cmd?>
Parameters
- mode: NextMode
- id: string
- cmd: string
Returns any
Overrides GeneralController.decode
- Defined in src/controllers/dummy-controller.ts:57

hello

hello(): string
name of this resource.

Returns string
Overrides GeneralController.hello
- Defined in src/controllers/dummy-controller.ts:51

type

type(): string
type of api-endpoint.

Returns string
Inherited from GeneralController.type
- Defined in src/controllers/general-controller.ts:48

Generated using TypeDoc