Class Govee

Hierarchy

EventEmitter
- Govee

Index

Constructors

constructor

new Govee(options?: Partial<GoveeOptions>): Govee
Parameters
- Optional options: Partial<GoveeOptions>
Returns Govee
Overrides EventEmitter.constructor
- Defined in src/govee.ts:45

Accessors

devices

get devices(): Device[]
Returns Device[]
- Defined in src/govee.ts:138

Methods

addListener

addListener<E>(event: E, listener: GoveeEvents[E]): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- listener: GoveeEvents[E]
Returns Govee
Inherited from EventEmitter.addListener
- Defined in src/govee.ts:202

destroy

destroy(): void
Returns void
- Defined in src/govee.ts:192

discover

discover(): void
Returns void
- Defined in src/govee.ts:176

emit

emit<E>(event: E, ...args: Parameters<GoveeEvents[E]>): boolean
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- Rest ...args: Parameters<GoveeEvents[E]>
Returns boolean
Inherited from EventEmitter.emit
- Defined in src/govee.ts:224

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from EventEmitter.eventNames
- Defined in src/govee.ts:229

getDevice

getDevice(id?: string): Promise<Device>
Parameters
- Optional id: string
Returns Promise<Device>
- Defined in src/govee.ts:142

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from EventEmitter.getMaxListeners
- Defined in src/govee.ts:234

listenerCount

listenerCount<E>(event: E): number
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
Returns number
Inherited from EventEmitter.listenerCount
- Defined in src/govee.ts:232

listeners

listeners<E>(event: E): GoveeEvents[E][]
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
Returns GoveeEvents[E][]
Inherited from EventEmitter.listeners
- Defined in src/govee.ts:231

off

off<E>(event: E, listener: GoveeEvents[E]): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- listener: GoveeEvents[E]
Returns Govee
Inherited from EventEmitter.off
- Defined in src/govee.ts:217

on

on<E>(event: E, listener: GoveeEvents[E]): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- listener: GoveeEvents[E]
Returns Govee
Inherited from EventEmitter.on
- Defined in src/govee.ts:206

once

once<E>(event: E, listener: GoveeEvents[E]): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- listener: GoveeEvents[E]
Returns Govee
Inherited from EventEmitter.once
- Defined in src/govee.ts:207

prependListener

prependListener<E>(event: E, listener: GoveeEvents[E]): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- listener: GoveeEvents[E]
Returns Govee
Inherited from EventEmitter.prependListener
- Defined in src/govee.ts:208

prependOnceListener

prependOnceListener<E>(event: E, listener: GoveeEvents[E]): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- listener: GoveeEvents[E]
Returns Govee
Inherited from EventEmitter.prependOnceListener
- Defined in src/govee.ts:212

rawListeners

rawListeners<E>(event: E): GoveeEvents[E][]
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
Returns GoveeEvents[E][]
Inherited from EventEmitter.rawListeners
- Defined in src/govee.ts:230

removeAllListeners

removeAllListeners<E>(event?: E): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- Optional event: E
Returns Govee
Inherited from EventEmitter.removeAllListeners
- Defined in src/govee.ts:218

removeListener

removeListener<E>(event: E, listener: GoveeEvents[E]): Govee
Type Parameters
- E extends keyof GoveeEvents
Parameters
- event: E
- listener: GoveeEvents[E]
Returns Govee
Inherited from EventEmitter.removeListener
- Defined in src/govee.ts:219

setDebug

setDebug(debug: boolean): void
Parameters
- debug: boolean
Returns void
- Defined in src/govee.ts:133

setMaxListeners

setMaxListeners(maxListeners: number): Govee
Parameters
- maxListeners: number
Returns Govee
Inherited from EventEmitter.setMaxListeners
- Defined in src/govee.ts:235

stopDiscover

stopDiscover(): void
Returns void
- Defined in src/govee.ts:184

waitForDevices

waitForDevices(): Promise<Govee>
Returns Promise<Govee>
- Defined in src/govee.ts:163

waitForReady

waitForReady(): Promise<Govee>
Returns Promise<Govee>
- Defined in src/govee.ts:153

Generated using TypeDoc