Class GeneralWEBController

class: GeneralWEBController

support additional helper functions for web-controller.

Hierarchy

GeneralController
- GeneralWEBController
  - GeneralAPIController

Index

Constructors

constructor

new GeneralWEBController(type: string, base?: CoreWEBController): GeneralWEBController
default constructor()
Parameters
- type: string
  
  type of this controller.
- Optional base: CoreWEBController
  
  the base controller to bypass.
Returns GeneralWEBController
Overrides GeneralController.constructor
- Defined in src/controllers/general-controller.ts:114

Properties

`Readonly` TYPE

TYPE: string

resource type of this Controller.

`Readonly` base

base: CoreWEBController

the base controller to bypass.

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

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>>
- 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
Overrides GeneralController.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>
- Defined in src/controllers/general-controller.ts:176

hello

hello(): string
name of this resource.

Returns string
Overrides GeneralController.hello
- Defined in src/controllers/general-controller.ts:122

type

type(): string
type of api-endpoint.

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

Class GeneralWEBController

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

type: string

Optional base: CoreWEBController

Returns GeneralWEBController

Properties

Readonly TYPE

Readonly base

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` base: CoreWEBController

`Readonly` TYPE

`Readonly` base

`Optional` type: string

`Optional` cmd: string

`Optional` type: string

`Optional` cmd: string

`Optional` $param: GeneralItem

`Optional` endpoint: string