Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HTTP

Hierarchy

  • Service
    • HTTP

Implements

  • IService

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • kaptan: Kaptan
    • Default value options: HTTPOptions = {}

    Returns HTTP

Properties

Protected kaptan

kaptan: Kaptan

Protected logger

logger: Logger

Private middlewares

middlewares: Middleware[] = []

Protected options

options: HTTPOptions

server

server: Server

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

emitIntercepted

  • emitIntercepted(event: string | symbol, ...args: any[]): Promise<any>

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns Promise<any>

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

Private handler

  • handler(request: IncomingMessage, response: ServerResponse, mc?: number): Promise<void>

  • Parameters

    • request: IncomingMessage
    • response: ServerResponse
    • Default value mc: number = 0

    Returns Promise<void>

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

onIntercepted

  • onIntercepted(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

onceIntercepted

  • onceIntercepted(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeListener

  • removeListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

start

  • start(): Promise<void>

  • Returns Promise<void>

stop

  • stop(): Promise<void>

  • Returns Promise<void>

use

Static copy

  • copy(name: string, service: ServiceConstructor): ServiceConstructor

  • Parameters

    • name: string
    • service: ServiceConstructor

    Returns ServiceConstructor

Static create

  • create(name: string, handlers: IService): ServiceConstructor

  • Parameters

    • name: string
    • handlers: IService

    Returns ServiceConstructor

Static getServiceName

  • getServiceName(service: ServiceConstructor | Service | string): string

  • Parameters

    • service: ServiceConstructor | Service | string

    Returns string

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static runIntercepted

  • runIntercepted(eventList: Function[], ...args: any[]): Promise<__type>

  • Parameters

    • eventList: Function[]
    • Rest ...args: any[]

    Returns Promise<__type>

Static spawn

  • spawn(service: ServiceConstructor, container: ServiceContainer, options?: undefined | __type): Service

  • Parameters

    • service: ServiceConstructor
    • container: ServiceContainer
    • Optional options: undefined | __type

    Returns Service

Generated using TypeDoc