Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiHost

An API host.

Hierarchy

Index

Properties

Accessors

Methods

Properties

Private _app

_app: express.Express

Private _authorizer

_authorizer: ApiAuthorizer

Private _logger

_logger: Logger

Private _poweredBy

_poweredBy: string = "@egodigital/egoose"

Private _root

_root: express.Router

Private _server

_server: HTTPServer

Private _useBodyParser

_useBodyParser: UseBodyParserSetting = true

Private _useErrorHandler

_useErrorHandler: UseErrorHandlerSetting

Accessors

app

  • get app(): express.Express

isRunning

  • get isRunning(): boolean

logger

root

  • get root(): express.Router

Methods

authorizer

initialize

poweredBy

  • poweredBy(): string
  • poweredBy(newValue: string): this

  • Gets or sets the 'X-Powered-By' header.

    Returns string

    The current value or that instance if new value has been set.

  • Parameters

    • newValue: string

    Returns this

setBasicAuth

setPrefixedAuthorizer

  • setPrefixedAuthorizer(authorizer: TokenAuthorizer, prefix?: string): this

  • Sets a prefixed based authorizer.

    Parameters

    • authorizer: TokenAuthorizer

      The authorizer.

    • Default value prefix: string = "bearer"

    Returns this

    this

Protected setupApi

  • setupApi(newApp: express.Express, newRoot: express.Router): void

  • Sets up a new api / app instance.

    Parameters

    • newApp: express.Express

      The instance to setup.

    • newRoot: express.Router

      The API root.

    Returns void

Protected setupLogger

  • setupLogger(newLogger: Logger): void

start

  • start(port?: number): Promise<boolean>

  • Starts the host.

    Parameters

    • Optional port: number

    Returns Promise<boolean>

    The promise, which indicates if operation successful or not.

stop

  • stop(): Promise<boolean>

  • Stops the host.

    Returns Promise<boolean>

    The promise, which indicates if operation successful or not.

useBodyParser

useErrorHandler

Generated using TypeDoc