Class NodeConnector

Hierarchy

Constructors

constructor

Properties

basePath cookie host http origin port secure DEFAULT_BASE_PATH HTTP_DOMAIN RESPONSE_HEADERS connections connectors

Methods

doSend fromFormat parseCookie prepareRequest prepareResponse send toFormat create isUsable toUri

Constructors

constructor

  • Parameters

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

    Returns NodeConnector

Properties

Readonly basePath

basePath: string

The base path of the api endpoint

Private cookie

cookie: null | string

Readonly host

host: string

the host to connect to

Private http

http: any

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

doSend

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

parseCookie

  • Parse the cookie header

    Returns

    Parameters

    • header: string

    Returns null | string

prepareRequest

prepareResponse

send

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

    Returns boolean

Static toUri

  • Parameters

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

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc