Class RemoteComponent

Remote component class

param: current application context
param: construct parameters

Hierarchy

RemoteComponent

Implements

IComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RemoteComponent(app: Application, opts?: RemoteComponentOptions): RemoteComponent

- Defined in components/remote.ts:32
Parameters
- app: Application
- Optional opts: RemoteComponentOptions
Returns RemoteComponent

Properties

Private app

app: Application

name

name: string = "__remote__"

opts

opts: RemoteComponentOptions

remote

remote: Gateway

Methods

genRemote

genRemote(opts: RemoteComponentOptions): Gateway

- Defined in components/remote.ts:147
Generate remote server instance

Parameters
- opts: RemoteComponentOptions
  
  contructor parameters for rpc Server
Returns Gateway

remote server instance

getRemotePaths

getRemotePaths(): RemoteServerCode[]

- Defined in components/remote.ts:112
Get remote paths from application

Returns RemoteServerCode[]

paths

start

start(cb: function): void

- Defined in components/remote.ts:84
Remote component lifecycle function

Parameters
- cb: function
  - - (): void
    - Returns void
Returns void

stop

stop(force: boolean, cb: function): void

- Defined in components/remote.ts:99
Remote component lifecycle function

Parameters
- force: boolean
  
  whether stop the component immediately
- cb: function
  - - (): void
    - Returns void
Returns void