devicekit.md

react-native-device-kit > DeviceKit

Class: DeviceKit

Hierarchy

EventEmitter

↳ DeviceKit

Index

Constructors

• constructor

Properties

• defaultMaxListeners

Methods

• addDevice
• addListener
• cancelPairings
• emit
• eventNames
• fetchDevices
• getMaxListeners
• listenerCount
• listeners
• off
• on
• once
• prependListener
• prependOnceListener
• rawListeners
• register
• removeAllListeners
• removeDevice
• removeListener
• setMaxListeners
• startCollection
• startScan
• stopCollection
• stopScan
• listenerCount

---

Constructors

constructor

⊕ new DeviceKit(): DeviceKit

Defined in index.ts:50

Returns: DeviceKit

---

Properties

<Static> defaultMaxListeners

● defaultMaxListeners: number

Inherited from EventEmitter.defaultMaxListeners

Defined in node_modules/@types/node/index.d.ts:1012

---

Methods

addDevice

▸ addDevice(device: Device): Promise<void>

Defined in index.ts:73

Parameters:

Param	Type
device	Device

Returns: Promise<void>

---

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener

Defined in node_modules/@types/node/index.d.ts:1014

Parameters:

Param	Type
event	string | symbol
listener	function

Returns: this

---

cancelPairings

▸ cancelPairings(): Promise<void>

Defined in index.ts:85

Returns: Promise<void>

---

emit

▸ emit(event: DATA, data: Reading): boolean

▸ emit(event: DEVICE_EVENTS, data: Device): boolean

▸ emit(event: STATE_EVENTS): boolean

Overrides EventEmitter.emit

Defined in index.ts:43

Parameters:

Param	Type
event	DATA
data	Reading

Returns: boolean

Overrides EventEmitter.emit

Defined in index.ts:44

Parameters:

Param	Type
event	DEVICE_EVENTS
data	Device

Returns: boolean

Overrides EventEmitter.emit

Defined in index.ts:45

Parameters:

Param	Type
event	STATE_EVENTS

Returns: boolean

---

eventNames

▸ eventNames(): Array< string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames

Defined in node_modules/@types/node/index.d.ts:1027

Returns: Array< string | symbol>

---

fetchDevices

▸ fetchDevices(): Promise<Device[]>

Defined in index.ts:81

Returns: Promise<Device[]>

---

getMaxListeners

▸ getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners

Defined in node_modules/@types/node/index.d.ts:1023

Returns: number

---

listenerCount

▸ listenerCount(type: * string | symbol*): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount

Defined in node_modules/@types/node/index.d.ts:1028

Parameters:

Param	Type
type	string | symbol

Returns: number

---

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners

Defined in node_modules/@types/node/index.d.ts:1024

Parameters:

Param	Type
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/index.d.ts:1020

Parameters:

Param	Type
event	string | symbol
listener	function

Returns: this

---

on

▸ on(event: DATA, fn: function): this

▸ on(event: DEVICE_EVENTS, fn: function): this

▸ on(event: STATE_EVENTS, fn: function): this

Overrides EventEmitter.on

Defined in index.ts:37

Parameters:

Param	Type
event	DATA
fn	function

Returns: this

Overrides EventEmitter.on

Defined in index.ts:38

Parameters:

Param	Type
event	DEVICE_EVENTS
fn	function

Returns: this

Overrides EventEmitter.on

Defined in index.ts:39

Parameters:

Param	Type
event	STATE_EVENTS
fn	function

Returns: this

---

once

▸ once(event: DATA, fn: function): this

▸ once(event: DEVICE_EVENTS, fn: function): this

▸ once(event: STATE_EVENTS, fn: function): this

Overrides EventEmitter.once

Defined in index.ts:40

Parameters:

Param	Type
event	DATA
fn	function

Returns: this

Overrides EventEmitter.once

Defined in index.ts:41

Parameters:

Param	Type
event	DEVICE_EVENTS
fn	function

Returns: this

Overrides EventEmitter.once

Defined in index.ts:42

Parameters:

Param	Type
event	STATE_EVENTS
fn	function

Returns: this

---

prependListener

▸ prependListener(event: * string | symbol*, listener: function): this

Inherited from EventEmitter.prependListener

Overrides EventEmitter.prependListener

Defined in node_modules/@types/node/index.d.ts:1017

Parameters:

Param	Type
event	string | symbol
listener	function

Returns: this

---

prependOnceListener

▸ prependOnceListener(event: * string | symbol*, listener: function): this

Inherited from EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener

Defined in node_modules/@types/node/index.d.ts:1018

Parameters:

Param	Type
event	string | symbol
listener	function

Returns: this

---

rawListeners

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

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners

Defined in node_modules/@types/node/index.d.ts:1025

Parameters:

Param	Type
event	string | symbol

Returns: Function[]

---

register

▸ register(key: string): Promise<void>

Defined in index.ts:61

Parameters:

Param	Type
key	string

Returns: Promise<void>

---

removeAllListeners

▸ removeAllListeners(event: EVENTS): this

Overrides EventEmitter.removeAllListeners

Defined in index.ts:47

Parameters:

Param	Type
event	EVENTS

Returns: this

---

removeDevice

▸ removeDevice(device: Device): Promise<void>

Defined in index.ts:77

Parameters:

Param	Type
device	Device

Returns: Promise<void>

---

removeListener

▸ removeListener(event: EVENTS, fn: function): this

Overrides EventEmitter.removeListener

Defined in index.ts:46

Parameters:

Param	Type
event	EVENTS
fn	function

Returns: this

---

setMaxListeners

▸ setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners

Defined in node_modules/@types/node/index.d.ts:1022

Parameters:

Param	Type
n	number

Returns: this

---

startCollection

▸ startCollection(): Promise<void>

Defined in index.ts:89

Returns: Promise<void>

---

startScan

▸ startScan(): Promise<void>

Defined in index.ts:65

Returns: Promise<void>

---

stopCollection

▸ stopCollection(): Promise<void>

Defined in index.ts:93

Returns: Promise<void>

---

stopScan

▸ stopScan(): Promise<void>

Defined in index.ts:69

Returns: Promise<void>

---

<Static> listenerCount

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

Inherited from EventEmitter.listenerCount

Defined in node_modules/@types/node/index.d.ts:1011

deprecated: since v4.0.0

Parameters:

Param	Type
emitter	EventEmitter
event	string | symbol

Returns: number

---