Scan | @cap32/scan-ip

IP Scaner

export
class: Scan
extends: {EventEmitter}

Hierarchy

EventEmitter
- Scan

Index

Constructors

constructor

Properties

defaultMaxListeners

Methods

Constructors

constructor

new Scan(options?: TOptions): Scan

- Defined in src/index.ts:60
Creates an instance of Scan.

memberof

Scan

Parameters
- Default value options: TOptions = {}
Returns Scan

Properties

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/events.d.ts:20
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(): void

- Defined in src/index.ts:178
stop scanning

memberof

Scan

Returns void

emit

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

Inherited from EventEmitter.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/events.d.ts:32
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:33
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:29
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:34
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:30
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string, listener: function): this
on(event: "progress", listener: function): this
on(event: "connect", listener: function): this
on(event: "refuse", listener: function): this
on(event: "complete", listener: function): this

Overrides EventEmitter.on
- Defined in src/index.ts:38
Parameters
- event: string
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:39
Parameters
- event: "progress"
- listener: function
  - - (scaned: number, total: number): void
    - Parameters
      - scaned: number
      - total: number
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:43
Parameters
- event: "connect"
- listener: function
  - - (host: string, port: number): void
    - Parameters
      - host: string
      - port: number
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:44
Parameters
- event: "refuse"
- listener: function
  - - (host: string, port: number): void
    - Parameters
      - host: string
      - port: number
      Returns void
Returns this
Overrides EventEmitter.on
- Defined in src/index.ts:45
Parameters
- event: "complete"
- listener: function
  - - (report: TReport): void
    - Parameters
      - report: TReport
      Returns void
Returns this

once

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

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/events.d.ts:22
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

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/events.d.ts:23
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

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:24
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:31
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- n: number
Returns this

start

start(): Promise<TReport>

- Defined in src/index.ts:163
start to scan

memberof

Scan

Returns Promise<TReport>

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:17
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value options: TOptions = {}

Returns Scan

Properties

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

close

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

on

Parameters

event: string

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "progress"

listener: function

Parameters

scaned: number

total: number

Returns void

Returns this

Parameters

event: "connect"

listener: function

Parameters

host: string

port: number

Returns void

Returns this

Parameters

event: "refuse"

listener: function

Parameters

host: string

port: number

Returns void

Returns this