Class DevToolsClient

A DevTools client.

Hierarchy

DisposableBase
- DevToolsClient

Implements

Disposable

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new DevToolsClient(opts?: DevToolsClientOptions): DevToolsClient

- Defined in devtools/index.ts:111
Initializes a new instance of that class.

Parameters
- Optional opts: DevToolsClientOptions
Returns DevToolsClient

Properties

Protected _DISPOSABLES

_DISPOSABLES: vscode.Disposable[] = []

Stores disposable sub objects.

Protected _INTERVALS

_INTERVALS: Timer[] = []

Stores intervals.

Protected _TIMEOUTS

_TIMEOUTS: Timer[] = []

Stores timeouts.

options

options: DevToolsClientOptions

Gets the options for the client.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

host

get host(): string

- Defined in devtools/index.ts:199
Gets the host address.

Returns string

isDisposed

get isDisposed(): boolean

Inherited from DisposableBase.isDisposed
- Defined in disposable/index.ts:106
Gets if object has been disposed or not.

Returns boolean

isDisposing

get isDisposing(): boolean

Inherited from DisposableBase.isDisposing
- Defined in disposable/index.ts:113
Gets if the 'dispose()' method is currently executed or not.

Returns boolean

isInFinalizeState

get isInFinalizeState(): boolean

Inherited from DisposableBase.isInFinalizeState
- Defined in disposable/index.ts:120
Gets if the object is disposed or currently disposing.

Returns boolean

port

get port(): number

- Defined in devtools/index.ts:216
Gets the TCP port.

Returns number

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:714
Parameters
- event: string | symbol
- listener: Function
Returns this

Protected cleanupIntervals

cleanupIntervals(): void

Inherited from DisposableBase.cleanupIntervals
- Defined in disposable/index.ts:54
Cleansup all timeouts.

Returns void

Protected cleanupTimeouts

cleanupTimeouts(): void

Inherited from DisposableBase.cleanupTimeouts
- Defined in disposable/index.ts:65
Cleansup all timeouts.

Returns void

dispose

dispose(): void

Inherited from DisposableBase.dispose
- Defined in disposable/index.ts:74
inheritdoc

Returns void

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:724
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:725
Returns (string | symbol)[]

Private getBrowserItems

getBrowserItems(): Promise<any[]>

- Defined in devtools/index.ts:123
Returns Promise<any[]>

getFrames

getFrames(): Promise<BrowserFrame[]>

- Defined in devtools/index.ts:144
Returns a list of all IFrames.

Returns Promise<BrowserFrame[]>

The promise with the frames.

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:722
Returns number

getPages

getPages(): Promise<BrowserPage[]>

- Defined in devtools/index.ts:173
Returns a list of all pages.

Returns Promise<BrowserPage[]>

The promise with the pages.

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:726
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:723
Parameters
- event: string | symbol
Returns Function[]

on

on(event: string | symbol, listener: Function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:715
Parameters
- event: string | symbol
- listener: Function
Returns this

Protected onDispose

onDispose(): void

Inherited from DisposableBase.onDispose
- Defined in disposable/index.ts:127
Additional logic for the 'dispose()' method.

Returns void

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:716
Parameters
- event: string | symbol
- listener: Function
Returns this

prependListener

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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:717
Parameters
- event: string | symbol
- listener: Function
Returns this

prependOnceListener

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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:718
Parameters
- event: string | symbol
- listener: Function
Returns this

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:720
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: Function): this

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:719
Parameters
- event: string | symbol
- listener: Function
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:721
Parameters
- n: number
Returns this

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in M:/VS Code/proj/vscode-helpers/node_modules/@types/node/index.d.ts:711
Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc