Class Scanner

Abstract scanner class

Hierarchy

Scanner
- NearestScanner
- NearScanner

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Scanner(timeoutMs?: number): Scanner

- Defined in scanner/src/scanner.ts:29
Constructor of Scanner class

Parameters
- Default value timeoutMs: number = Scanner.DEFAULT_TIMEOUT_MS
  
  timeout duration in millisecond. 0 means no timeout.
Returns Scanner

Properties

Protected eventEmitter

eventEmitter: TypedEmitter<Event> = new EventEmitter() as TypedEmitter<Event>

Static Protected DEFAULT_TIMEOUT_MS

DEFAULT_TIMEOUT_MS: number = 0

Methods

Protected Abstract executor

executor(resolve: function, reject: function): void

- Defined in scanner/src/scanner.ts:94
Parameters
- resolve: function
  - - (value: Cube | Cube[]): void
    - Parameters
      - value: Cube | Cube[]
      Returns void
- reject: function
  - - (reason?: string): void
    - Parameters
      - Optional reason: string
      Returns void
Returns void

off

off<E>(event: E, listener: Event[E]): this

- Defined in scanner/src/scanner.ts:87
Type parameters
- E: keyof Event
Parameters
- event: E
- listener: Event[E]
Returns this

on

on<E>(event: E, listener: Event[E]): this

- Defined in scanner/src/scanner.ts:82
Type parameters
- E: keyof Event
Parameters
- event: E
- listener: Event[E]
Returns this

Protected Abstract onDiscover

onDiscover(peripheral: noble.Peripheral): void

- Defined in scanner/src/scanner.ts:92
Parameters
- peripheral: noble.Peripheral
Returns void

Protected onStateChange

onStateChange(state: string): void

- Defined in scanner/src/scanner.ts:96
Parameters
- state: string
Returns void

start

start(): Promise<Cube | Cube[]>

- Defined in scanner/src/scanner.ts:45
Start scanning

Returns Promise<Cube | Cube[]>

Promise object

stop

stop(): void

- Defined in scanner/src/scanner.ts:72
Stop scanning

Returns void

Generated using TypeDoc