Class MidwayServerlessFunctionService

Hierarchy

MidwayWebRouterService
- MidwayServerlessFunctionService

Index

Constructors

Properties

Methods

addController addRouter addServerlessFunction analyze analyzeController analyzeFunction checkDuplicateAndPush collectFunctionRoute getFlattenRouterTable getFunctionList getMatchedRouterInfo getRoutePriorityList getRouterTable sortPrefixAndRouter sortRouter

Constructors

constructor

new MidwayServerlessFunctionService(options?: RouterCollectorOptions): MidwayServerlessFunctionService
Parameters
- options: RouterCollectorOptions = {}
Returns MidwayServerlessFunctionService
Overrides MidwayWebRouterService.constructor
- Defined in packages/core/src/service/slsFunctionService.ts:30

Properties

`Readonly` options

options: RouterCollectorOptions = {}

`Protected` routes

routes: Map<string, RouterInfo[]> = ...

`Protected` routesPriority

routesPriority: RouterPriority[] = []

Methods

addController

addController(controllerClz: any, controllerOption: ControllerOption, functionMeta?: boolean): any
dynamically add a controller
Parameters
- controllerClz: any
- controllerOption: ControllerOption
- Optional functionMeta: boolean
Returns any
Inherited from MidwayWebRouterService.addController
- Defined in packages/core/src/service/webRouterService.ts:210
addController(controllerClz: any, controllerOption: ControllerOption, resourceOptions?: {
resourceFilter: ((routerInfo: RouterInfo) => boolean);
}, functionMeta?: boolean): any
Parameters
- controllerClz: any
- controllerOption: ControllerOption
- Optional resourceOptions: {
  resourceFilter: ((routerInfo: RouterInfo) => boolean);
  }
  - resourceFilter: ((routerInfo: RouterInfo) => boolean)
    - (routerInfo: RouterInfo): boolean
      
      Parameters
      
      routerInfo: RouterInfo
      
      Returns boolean
- Optional functionMeta: boolean
Returns any
Inherited from MidwayWebRouterService.addController
- Defined in packages/core/src/service/webRouterService.ts:215

addRouter

addRouter(routerFunction: ((...args: any[]) => void), routerInfoOption: DynamicRouterInfo): void
dynamically add a route to root prefix
Parameters
- routerFunction: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
- routerInfoOption: DynamicRouterInfo
Returns void
Inherited from MidwayWebRouterService.addRouter
- Defined in packages/core/src/service/webRouterService.ts:373

addServerlessFunction

addServerlessFunction(func: ((...args: any[]) => Promise<any>), triggerOptions: TriggerMetadata, functionOptions?: ServerlessFunctionOptions): void
Parameters
- func: ((...args: any[]) => Promise<any>)
  - - (...args: any[]): Promise<any>
    - Parameters
      
      Rest ...args: any[]
      
      Returns Promise<any>
- triggerOptions: TriggerMetadata
- functionOptions: ServerlessFunctionOptions = {}
Returns void
- Defined in packages/core/src/service/slsFunctionService.ts:200

`Protected` checkDuplicateAndPush

checkDuplicateAndPush(prefix: any, routerInfo: RouterInfo): void
Parameters
- prefix: any
- routerInfo: RouterInfo
Returns void
Inherited from MidwayWebRouterService.checkDuplicateAndPush
- Defined in packages/core/src/service/webRouterService.ts:540

`Protected` collectFunctionRoute

collectFunctionRoute(module: any): void
Parameters
- module: any
Returns void
- Defined in packages/core/src/service/slsFunctionService.ts:68

getFlattenRouterTable

getFlattenRouterTable(options?: {
compileUrlPattern?: boolean;
}): Promise<RouterInfo[]>
Parameters
- options: {
  compileUrlPattern?: boolean;
  } = {}
  - Optional compileUrlPattern?: boolean
Returns Promise<RouterInfo[]>
Inherited from MidwayWebRouterService.getFlattenRouterTable
- Defined in packages/core/src/service/webRouterService.ts:490

getFunctionList

getFunctionList(): Promise<RouterInfo[]>
Returns Promise<RouterInfo[]>
- Defined in packages/core/src/service/slsFunctionService.ts:194

getMatchedRouterInfo

getMatchedRouterInfo(routerUrl: string, method: string): Promise<RouterInfo>
Parameters
- routerUrl: string
- method: string
Returns Promise<RouterInfo>
Inherited from MidwayWebRouterService.getMatchedRouterInfo
- Defined in packages/core/src/service/webRouterService.ts:516

getRoutePriorityList

getRoutePriorityList(): Promise<RouterPriority[]>
Returns Promise<RouterPriority[]>
Inherited from MidwayWebRouterService.getRoutePriorityList
- Defined in packages/core/src/service/webRouterService.ts:474

getRouterTable

getRouterTable(): Promise<Map<string, RouterInfo[]>>
Returns Promise<Map<string, RouterInfo[]>>
Inherited from MidwayWebRouterService.getRouterTable
- Defined in packages/core/src/service/webRouterService.ts:482

`Protected` sortPrefixAndRouter

sortPrefixAndRouter(): void
Returns void
Inherited from MidwayWebRouterService.sortPrefixAndRouter
- Defined in packages/core/src/service/webRouterService.ts:180

sortRouter

sortRouter(urlMatchList: RouterInfo[]): {
    _category: number;
    _level: number;
    _paramString: string;
    _pureRouter: string;
    _weight: number;
    controllerClz?: (new (...args: any[]) => any);
    controllerId?: string;
    controllerMiddleware?: any[];
    description?: string;
    fullUrl?: string;
    fullUrlCompiledRegexp?: RegExp;
    fullUrlFlattenString?: string;
    funcHandlerName?: string;
    functionMetadata?: any;
    functionName?: string;
    functionTriggerMetadata?: any;
    functionTriggerName?: string;
    handlerName?: string;
    id?: string;
    method: string | ((...args: any[]) => void);
    middleware?: any[];
    prefix?: string;
    requestMetadata?: any[];
    requestMethod: string;
    responseMetadata?: any[];
    routerName?: string;
    summary?: string;
    url: string | RegExp;
}[]
Parameters
- urlMatchList: RouterInfo[]
Returns {
    _category: number;
    _level: number;
    _paramString: string;
    _pureRouter: string;
    _weight: number;
    controllerClz?: (new (...args: any[]) => any);
    controllerId?: string;
    controllerMiddleware?: any[];
    description?: string;
    fullUrl?: string;
    fullUrlCompiledRegexp?: RegExp;
    fullUrlFlattenString?: string;
    funcHandlerName?: string;
    functionMetadata?: any;
    functionName?: string;
    functionTriggerMetadata?: any;
    functionTriggerName?: string;
    handlerName?: string;
    id?: string;
    method: string | ((...args: any[]) => void);
    middleware?: any[];
    prefix?: string;
    requestMetadata?: any[];
    requestMethod: string;
    responseMetadata?: any[];
    routerName?: string;
    summary?: string;
    url: string | RegExp;
}[]
Inherited from MidwayWebRouterService.sortRouter
- Defined in packages/core/src/service/webRouterService.ts:405

Class MidwayServerlessFunctionService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: RouterCollectorOptions = {}

Returns MidwayServerlessFunctionService

Properties

Readonly options

Protected routes

Protected routesPriority

Methods

addController

Parameters

controllerClz: any

controllerOption: ControllerOption

Optional functionMeta: boolean

Returns any

Parameters

controllerClz: any

controllerOption: ControllerOption

Optional resourceOptions: { resourceFilter: ((routerInfo: RouterInfo) => boolean); }

resourceFilter: ((routerInfo: RouterInfo) => boolean)

Parameters

routerInfo: RouterInfo

Returns boolean

Optional functionMeta: boolean

Returns any

addRouter

Parameters

routerFunction: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

routerInfoOption: DynamicRouterInfo

Returns void

addServerlessFunction

Parameters

func: ((...args: any[]) => Promise<any>)

Parameters

Rest ...args: any[]

Returns Promise<any>

triggerOptions: TriggerMetadata

functionOptions: ServerlessFunctionOptions = {}

Returns void

Protected analyze

Returns Promise<void>

Protected analyzeController

Returns void

Protected analyzeFunction

Returns void

Protected checkDuplicateAndPush

Parameters

prefix: any

routerInfo: RouterInfo

Returns void

Protected collectFunctionRoute

Parameters

module: any

Returns void

getFlattenRouterTable

Parameters

options: { compileUrlPattern?: boolean; } = {}

Optional compileUrlPattern?: boolean

Returns Promise<RouterInfo[]>

getFunctionList

Returns Promise<RouterInfo[]>

getMatchedRouterInfo

Parameters

routerUrl: string

method: string

Returns Promise<RouterInfo>

getRoutePriorityList

Returns Promise<RouterPriority[]>

getRouterTable

Returns Promise<Map<string, RouterInfo[]>>

`Readonly` options

`Protected` routes

`Protected` routesPriority

`Optional` functionMeta: boolean

`Optional` resourceOptions: {
resourceFilter: ((routerInfo: RouterInfo) => boolean);
}

`Optional` functionMeta: boolean

`Rest` ...args: any[]

`Rest` ...args: any[]

`Protected` analyze

`Protected` analyzeController

`Protected` analyzeFunction

`Protected` checkDuplicateAndPush

`Protected` collectFunctionRoute

options: {
compileUrlPattern?: boolean;
} = {}

`Optional` compileUrlPattern?: boolean

`Protected` sortPrefixAndRouter