Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BrowserItem

A browser item.

Hierarchy

Index

Properties

Methods

Properties

Readonly close

close: () => PromiseLike<boolean>

Closes the connection to the item.

returns

The promise that indicates if operation was successful or not.

Type declaration

    • (): PromiseLike<boolean>

    • Returns PromiseLike<boolean>

Readonly connect

connect: () => PromiseLike<boolean>

Options a connection to the item.

returns

The promise that indicates if operation was successful or not.

Type declaration

    • (): PromiseLike<boolean>

    • Returns PromiseLike<boolean>

Optional Readonly description

description: string

The description.

Readonly id

id: string

The ID of the item.

Readonly isConnected

isConnected: boolean

Indicates if a connection to the item has been established or not.

Readonly send

send: (method: string, params?: any, callback?: SendToBrowserItemCallback) => PromiseLike<void>

Invokes a method for the item.

param

The method to invoke.

param

Parameters for the method.

param

The optional callback.

Type declaration

Readonly socketUri

socketUri: string

Gets the underyling (web) socket URI.

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): BrowserItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BrowserItem

dispose

  • dispose(): any

  • Dispose this object.

    Returns any

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

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): BrowserItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BrowserItem

on

  • on(event: string | symbol, listener: (...args: any[]) => void): BrowserItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BrowserItem

once

  • once(event: string | symbol, listener: (...args: any[]) => void): BrowserItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BrowserItem

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): BrowserItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BrowserItem

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): BrowserItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BrowserItem

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

  • Parameters

    • Optional event: string | symbol

    Returns BrowserItem

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): BrowserItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns BrowserItem

setMaxListeners

  • Parameters

    • n: number

    Returns BrowserItem

Generated using TypeDoc