Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiHost

An API host.

Hierarchy

  • DisposableBase
    • ApiHost

Implements

  • Disposable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Initializes a new instance of that class.

    Parameters

    • workspace: Workspace

      The underlying workspace.

    • port: number

      The TCP port the host should listen on.

    • settings: ApiSettings

      The settings for that host.

    Returns ApiHost

Properties

Protected _DISPOSABLES

_DISPOSABLES: vscode.Disposable[]

Stores disposable sub objects.

Private _EVENTS

_EVENTS: EventEmitter = new Events.EventEmitter()

Private _GLOBAL_STATE

_GLOBAL_STATE: deploy_contracts.KeyValuePairs

Protected _INTERVALS

_INTERVALS: Timer[]

Stores intervals.

Private _SCRIPT_STATES

_SCRIPT_STATES: deploy_contracts.KeyValuePairs

Protected _TIMEOUTS

_TIMEOUTS: Timer[]

Stores timeouts.

Private _server

_server: Server | Server

isDisposed

isDisposed: boolean

Gets if object has been disposed or not.

isDisposing

isDisposing: boolean

Gets if the 'dispose()' method is currently executed or not.

isInFinalizeState

isInFinalizeState: boolean

Gets if the object is disposed or currently disposing.

port

port: number

The TCP port the host should listen on.

settings

settings: ApiSettings

The settings for that host.

workspace

workspace: Workspace

The underlying workspace.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

autoStart

  • get autoStart(): boolean

  • Gets if the host should be started automatically or not.

    Returns boolean

isRunning

  • get isRunning(): boolean

  • Gets if the host is currently running or not.

    Returns boolean

Methods

addListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected cleanupIntervals

  • cleanupIntervals(): void

  • Cleansup all timeouts.

    Returns void

Protected cleanupTimeouts

  • cleanupTimeouts(): void

  • Cleansup all timeouts.

    Returns void

Private createHostInfo

Private createInstance

  • createInstance(): Promise<Express.Express>

  • Returns Promise<Express.Express>

Private createMeInfo

  • createMeInfo(req: Express.Request): MeInfo

Private createVSCodeInfo

dispose

  • dispose(): void
  • inheritdoc

    Returns void

emit

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

  • Parameters

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

    Returns boolean

eventNames

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

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getNameAndDescription

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

    Returns this

Protected onDispose

  • onDispose(): void
  • inheritdoc

    Returns void

once

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

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

  • Parameters

    • event: string | symbol
    • listener: Function

    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

    Returns this

replaceWithValues

  • replaceWithValues(val: any): string

  • Handles a value as string and replaces placeholders.

    Parameters

    • val: any

      The value to parse.

    Returns string

    The parsed value.

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

Private setupCustomEndpoints

  • setupCustomEndpoints(app: Express.Express): Promise<void>

  • Parameters

    • app: Express.Express

    Returns Promise<void>

Private setupEndPoints

  • setupEndPoints(app: Express.Express): Promise<void>

  • Parameters

    • app: Express.Express

    Returns Promise<void>

start

  • start(): Promise<boolean>

  • Starts the host.

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not.

stop

  • stop(): Promise<boolean>

  • Stops the host.

    Returns Promise<boolean>

    The promise that indicates if operation was successful or not.

Static listenerCount

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

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc