Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RemoteService

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

clients

clients: Remote[] | null

Protected kaptan

kaptan: Kaptan

Protected logger

logger: Logger

Protected network

network: Network

Protected options

options: IRemoteServiceOpts

server

server: Remote | null

state

state: object

Type declaration

  • [key: string]: any

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

isServer

  • get isServer(): boolean

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>

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

getExposedMethod

  • getExposedMethod(method: string): any

getMaxListeners

  • getMaxListeners(): number

  • Returns number

getServiceState

  • getServiceState(): object

Private init

  • init(): 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

Private onRemoteServiceInit

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

setState

  • setState(state: object, remotelyUpdated?: boolean): void

  • Parameters

    • state: object
      • [key: string]: any
    • Default value remotelyUpdated: boolean = false

    Returns void

start

  • start(): Promise<void>

stop

  • stop(): Promise<void>

Static copy

Static create

Static getServiceName

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<Object>

Static spawn

Generated using TypeDoc