Class ConnectorAbstract

Hierarchy

Constructors

constructor

Properties

basePath host origin port secure DEFAULT_BASE_PATH HTTP_DOMAIN RESPONSE_HEADERS connections connectors

Methods

doSend fromFormat prepareRequest prepareResponse send toFormat create isUsable toUri

Constructors

constructor

  • Parameters

    • host: string

      the host to connect to

    • port: number

      the port to connect to

    • secure: boolean

      true for an secure connection

    • basePath: string

      The base path of the api endpoint

    Returns Connector

Properties

Readonly basePath

basePath: string

The base path of the api endpoint

Readonly host

host: string

the host to connect to

Readonly origin

origin: string = ...

the origin do not contains the base path

Readonly port

port: number

the port to connect to

Readonly secure

secure: boolean

true for an secure connection

Static Readonly DEFAULT_BASE_PATH

DEFAULT_BASE_PATH: "/v1" = '/v1'

Static Readonly HTTP_DOMAIN

HTTP_DOMAIN: ".app.baqend.com" = '.app.baqend.com'

Static Readonly RESPONSE_HEADERS

RESPONSE_HEADERS: string[] = ...

An array of all exposed response headers

Static Readonly connections

connections: {
    [origin: string]: Connector;
} = {}

Array of all created connections

Type declaration

Static Readonly connectors

connectors: (Class<Connector> & typeof Connector)[] = []

Array of all available connector implementations

Methods

Abstract doSend

Protected Abstract fromFormat

  • Convert received data to the requested response entity type

    Returns

    Parameters

    • response: Response

      The response object

    • entity: any

      The received data

    • type: null | ResponseBodyType

      The requested response format

    Returns any

prepareRequest

prepareResponse

  • Returns

    Parameters

    • message: Message
    • response: Response

      The received response headers and data

    Returns Promise<any>

send

Protected Abstract toFormat

  • Convert the message entity to the sendable representation

    Returns

    Parameters

    • message: Message

      The message to send

    Returns void

Static create

  • Returns

    Parameters

    • host: string

      or location

    • Optional port: number
    • Optional secure: boolean
    • Optional basePath: string

      The basepath of the api

    Returns Connector

Static isUsable

  • Indicates id this connector is usable in the current runtime environment This method must be overwritten in subclass implementations

    Returns

    true if this connector is usable in the current environment

    Parameters

    • host: string

      the host to connect to

    • port: number

      the port to connect to

    • secure: boolean

      true for an secure connection

    • basePath: string

      The base path of the api endpoint

    Returns boolean

Static toUri

  • Parameters

    • host: string
    • port: number
    • secure: boolean
    • basePath: string

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc