Class WebService<APP_STATE>Abstract

constructor

• new WebService<APP_STATE>(
      props: IInternalWebServiceProps<APP_STATE>,
  ): WebService<APP_STATE>

  Constructor for WebService base class. Note: For subclasses of this, it is recommended to use IWebServiceProps to simplify user implementation usage.

  Type Parameters

  • APP_STATE

  Parameters

  • props: IInternalWebServiceProps<APP_STATE>

    internal props

  Returns WebService<APP_STATE>

ReadonlyinstanceId

Readonlyname

ReadonlypackageName

path

Readonlyport

install

• install(props: IRunProps): Promise<IRunResult>

  Installs the WebService to the app.

  Parameters

  • props: IRunProps

    for install

  Returns Promise<IRunResult>

isInstalled

• isInstalled(): boolean

  Whether the app is installed or not.

  Returns boolean

toJson

• toJson(): {
      installedRouters: any;
      instanceId: string;
      isInstalled: boolean;
      logger: any;
      middleware: any;
      name: string;
      packageName: string;
      path: string;
      port: number;
      state: any;
  }

  Serializes the web service to a plain JSON-compatible object. Logger and state are omitted for safety.

  Returns {
      installedRouters: any;
      instanceId: string;
      isInstalled: boolean;
      logger: any;
      middleware: any;
      name: string;
      packageName: string;
      path: string;
      port: number;
      state: any;
  }

  JSON representation of this web service

toString

• toString(): string

  Returns a JSON string representation of this web service.

  Returns string

  stringified JSON of the web service

uninstall

• uninstall(props: IRunProps): Promise<any>

  Uninstalls the WebService from the app.

  Parameters

  • props: IRunProps

    for uninstall

  Returns Promise<any>

uninstallMiddlewares

• uninstallMiddlewares(): Promise<void>

  Removes all currently installed middleware from the Express app.

  Returns Promise<void>