Class GeneralAPIController<T, ModelType>

class: APIController

support basic CRUD with TypedManager

Type Parameters

T extends TypedStorageService<CoreModel<ModelType>, ModelType>
ModelType extends string

Hierarchy

GeneralWEBController
- GeneralAPIController

Index

Constructors

constructor

new GeneralAPIController<T, ModelType>(type: string, storage: T, search: Elastic6SimpleQueriable<any>, uniqueField?: string): GeneralAPIController<T, ModelType>
default constructor
Type Parameters
- T extends TypedStorageService<CoreModel<ModelType>, ModelType, T>
- ModelType extends string
Parameters
- type: string
  
  type of REST API
- storage: T
  
  storage-service
- search: Elastic6SimpleQueriable<any>
  
  search-service
- Optional uniqueField: string
  
  (optional) field in unique to lookup the origin id.
Returns GeneralAPIController<T, ModelType>
Overrides GeneralWEBController.constructor
- Defined in src/controllers/general-api-controller.ts:42

Properties

`Readonly` NS

NS: string

`Readonly` TYPE

TYPE: string

resource type of this Controller.

`Readonly` base

base: CoreWEBController

the base controller to bypass.

deleteBase

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

delete (or destroy) node

getBase

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

read node

listBase

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

search node

postBase

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

save (or create) node.

putBase

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

update node.

throw error if not found.

`Protected` search

search: Elastic6SimpleQueriable<any>

`Protected` storage

storage: T

`Protected` unique

unique: UniqueFieldManager<CoreModel<ModelType>, ModelType>

Methods

asFuncName

asFuncName(mode: string, type?: string, cmd?: string): string
override decoder of function-name.
1. try to find default.
2. use 'base' function.
Parameters
- mode: string
- Optional type: string
- Optional cmd: string
Returns string
Overrides GeneralWEBController.asFuncName
- Defined in src/controllers/general-api-controller.ts:60

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 GeneralWEBController.asFuncNameByDo
- Defined in src/controllers/general-controller.ts:88

asNextIdentityAccess

asNextIdentityAccess(context: NextContext<NextIdentity<any>>): Promise<NextIdentityAccess<any>>
translate to NextIdentityAccess from origin NextContext
- use api://lemon-accounts-api/oauth/0/pack-context via protocol.
Parameters
- context: NextContext<NextIdentity<any>>
  
  the requested NextContext
Returns Promise<NextIdentityAccess<any>>
Inherited from GeneralWEBController.asNextIdentityAccess
- Defined in src/controllers/general-controller.ts:148

decode

decode(mode: NextMode, id: string, cmd: string): any
decode func from self to base.
Parameters
- mode: NextMode
- id: string
- cmd: string
Returns any
Inherited from GeneralWEBController.decode
- Defined in src/controllers/general-controller.ts:127

doNotifyServiceEvent

doNotifyServiceEvent(context: NextContext<NextIdentity<any>>, type: string, id: string, state: string, $param?: GeneralItem, endpoint?: string): Promise<string>
notify self-service's event message via SNS
- config env.EVENT_RELAY_SNS as SNS endpoint.
Returns
message-id
Parameters
- context: NextContext<NextIdentity<any>>
- type: string
- id: string
- state: string
- Optional $param: GeneralItem
- Optional endpoint: string
Returns Promise<string>
Inherited from GeneralWEBController.doNotifyServiceEvent
- Defined in src/controllers/general-controller.ts:176

hello

hello(): string
name of this resource.

Returns string
Overrides GeneralWEBController.hello
- Defined in src/controllers/general-api-controller.ts:53

type

type(): string
type of api-endpoint.

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

Class GeneralAPIController<T, ModelType>

Type Parameters

T extends TypedStorageService<CoreModel<ModelType>, ModelType>

ModelType extends string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends TypedStorageService<CoreModel<ModelType>, ModelType, T>

ModelType extends string

Parameters

type: string

storage: T

search: Elastic6SimpleQueriable<any>

Optional uniqueField: string

Returns GeneralAPIController<T, ModelType>

Properties

Readonly NS

Readonly TYPE

Readonly base

deleteBase

getBase

listBase

postBase

putBase

Protected search

Protected storage

Protected unique

Methods

asFuncName

Parameters

mode: string

Optional type: string

Optional cmd: string

Returns string

asFuncNameByDo

Parameters

mode: string

Optional type: string

Optional cmd: string

Returns string

asNextIdentityAccess

Parameters

context: NextContext<NextIdentity<any>>

Returns Promise<NextIdentityAccess<any>>

decode

Parameters

mode: NextMode

id: string

cmd: string

Returns any

doNotifyServiceEvent

Returns

Parameters

context: NextContext<NextIdentity<any>>

type: string

id: string

state: string

Optional $param: GeneralItem

Optional endpoint: string

Returns Promise<string>

hello

Returns string

type

Returns string

Settings

Member Visibility

Theme

`Optional` uniqueField: string

`Readonly` NS

`Readonly` TYPE

`Readonly` base

`Protected` search

`Protected` storage

`Protected` unique

`Optional` type: string

`Optional` cmd: string

`Optional` type: string

`Optional` cmd: string

`Optional` $param: GeneralItem

`Optional` endpoint: string