@snap/camera-kit
Version:
Camera Kit Web
97 lines (50 loc) • 1.68 kB
Markdown
[**CameraKit Web SDK v1.13.0**](../README.md)
***
[CameraKit Web SDK](../globals.md) / TypedEventTarget
# Class: TypedEventTarget\<Events\>
This wrapper around EventTarget provides more descriptive type information. By using this class, calls to EventTarget
methods are correctly type checked to ensure only allowed event types are used, and that events and their type
strings are correctly associated.
For example, when calling TypedEventTarget::addEventListener, the event passed to the callback will have the correct
type corresponding to the type of event for which the listener has been added.
## Type Parameters
• **Events** *extends* [`TypedCustomEvent`](TypedCustomEvent.md) = [`TypedCustomEvent`](TypedCustomEvent.md)
## Constructors
### new TypedEventTarget()
> **new TypedEventTarget**\<`Events`\>(): [`TypedEventTarget`](TypedEventTarget.md)\<`Events`\>
#### Returns
[`TypedEventTarget`](TypedEventTarget.md)\<`Events`\>
## Methods
### addEventListener()
> **addEventListener**\<`K`\>(`type`, `callback`, `options`?): `void`
#### Type Parameters
• **K** *extends* `string`
#### Parameters
##### type
`K`
##### callback
`TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\>
##### options?
`TypedEventListenerOptions`
#### Returns
`void`
***
### dispatchEvent()
> **dispatchEvent**(`event`): `true`
#### Parameters
##### event
`Events`
#### Returns
`true`
***
### removeEventListener()
> **removeEventListener**\<`K`\>(`type`, `callback`): `void`
#### Type Parameters
• **K** *extends* `string`
#### Parameters
##### type
`K`
##### callback
`TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\>
#### Returns
`void`