Class EventService

Event Service

Hierarchy

TypedDispatcher<MicrobitEvents, this>
- EventService

Methods

addEventListener

addEventListener<K>(type, listener): void
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- type: K
- listener: ((event: CustomEvent<MicrobitEvents[K]>) => void)
  - - (event): void
    - Parameters
      event: CustomEvent<MicrobitEvents[K]>
      Returns void
Returns void
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).addEventListener
- Defined in src/event-dispatcher.ts:32

addListener

addListener<K>(event, listener): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- listener: ((data: MicrobitEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MicrobitEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).addListener
- Defined in src/event-dispatcher.ts:36

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: CustomEvent<MicrobitEvents>
Returns boolean
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).dispatchEvent
- Defined in src/event-dispatcher.ts:34
dispatchEvent<K>(type, detail): boolean
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- type: K
- detail: MicrobitEvents[K]
Returns boolean
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).dispatchEvent
- Defined in src/event-dispatcher.ts:35

emit

emit<K>(event, data): boolean
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- data: MicrobitEvents[K]
Returns boolean
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).emit
- Defined in src/event-dispatcher.ts:46

eventNames

eventNames<K>(): K[]
Type Parameters
- K extends keyof MicrobitEvents
Returns K[]
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).eventNames
- Defined in src/event-dispatcher.ts:47

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).getMaxListeners
- Defined in src/event-dispatcher.ts:50

getMicrobitRequirements

getMicrobitRequirements(): Promise<MicrobitEvent>
Get micro:bit event requirements

Returns Promise<MicrobitEvent>
- Defined in src/services/event.ts:112

listenerCount

listenerCount<K>(type): number
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- type: K
Returns number
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).listenerCount
- Defined in src/event-dispatcher.ts:48

listeners

listeners<K>(event): Function[]
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
Returns Function[]
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).listeners
- Defined in src/event-dispatcher.ts:45

off

off<K>(event, listener): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- listener: ((data: MicrobitEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MicrobitEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).off
- Defined in src/event-dispatcher.ts:39

on

on<K>(event, listener): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- listener: ((data: MicrobitEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MicrobitEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).on
- Defined in src/event-dispatcher.ts:37

once

once<K>(event, listener): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- listener: ((data: MicrobitEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MicrobitEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).once
- Defined in src/event-dispatcher.ts:38

prependListener

prependListener<K>(event, listener): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- listener: ((data: MicrobitEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MicrobitEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).prependListener
- Defined in src/event-dispatcher.ts:40

prependOnceListener

prependOnceListener<K>(event, listener): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- listener: ((data: MicrobitEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MicrobitEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).prependOnceListener
- Defined in src/event-dispatcher.ts:41

rawListeners

rawListeners<K>(event): Function[]
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
Returns Function[]
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).rawListeners
- Defined in src/event-dispatcher.ts:52

readMicrobitEvent

readMicrobitEvent(): Promise<MicrobitEvent>
Read micro:bit event

Returns Promise<MicrobitEvent>
- Defined in src/services/event.ts:132

removeAllListeners

removeAllListeners<K>(event?): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- Optionalevent: K
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).removeAllListeners
- Defined in src/event-dispatcher.ts:43

removeEventListener

removeEventListener<K>(type, callback): void
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- type: K
- callback: ((event: CustomEvent<MicrobitEvents[K]>) => void)
  - - (event): void
    - Parameters
      event: CustomEvent<MicrobitEvents[K]>
      Returns void
Returns void
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).removeEventListener
- Defined in src/event-dispatcher.ts:33

removeListener

removeListener<K>(event, listener): this
Type Parameters
- K extends keyof MicrobitEvents
Parameters
- event: K
- listener: ((data: MicrobitEvents[K]) => void)
  - - (data): void
    - Parameters
      data: MicrobitEvents[K]
      Returns void
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).removeListener
- Defined in src/event-dispatcher.ts:42

setClientRequirements

setClientRequirements(type, value): Promise<void>
Set client event requirements
Parameters
- type: number
  The type of event to set
- value: number
  The value to set
Returns Promise<void>
- Defined in src/services/event.ts:122

setMaxListeners

setMaxListeners(n): this
Parameters
- n: number
Returns this
Inherited from (EventDispatcher as new() => TypedDispatcher<MicrobitEvents>).setMaxListeners
- Defined in src/event-dispatcher.ts:49

writeClientEvent

writeClientEvent(type, value): Promise<void>
Write client event
Parameters
- type: number
  The event type
- value: number
  The event value
Returns Promise<void>
- Defined in src/services/event.ts:142

Class EventService

Hierarchy

Index

Methods

Methods

addEventListener

Type Parameters

Parameters

Parameters

Returns void

Returns void

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

dispatchEvent

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

emit

Type Parameters

Parameters

Returns boolean

eventNames

Type Parameters

Returns K[]

getMaxListeners

Returns number

getMicrobitRequirements

Returns Promise<MicrobitEvent>

listenerCount

Type Parameters

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns Function[]

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

on

Type Parameters

Parameters

Parameters

Returns void

Returns this

once

Type Parameters

Parameters

Parameters

Returns void

Returns this

prependListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

prependOnceListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

rawListeners

Type Parameters

Parameters

Returns Function[]

readMicrobitEvent

Returns Promise<MicrobitEvent>

removeAllListeners

Type Parameters