UNPKG

@snap/camera-kit

Version:

Camera Kit Web

ar.snap.com/camera-kit

108 lines (65 loc) • 2.38 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
[CameraKit Web SDK - v0.22.0](../README.md) / [Exports](../modules.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 | Name | Type | | :------ | :------ | | `Events` | extends [`TypedCustomEvent`](TypedCustomEvent.md) = [`TypedCustomEvent`](TypedCustomEvent.md) | ## Table of contents ### Constructors - [constructor](TypedEventTarget.md#constructor) ### Methods - [addEventListener](TypedEventTarget.md#addeventlistener) - [dispatchEvent](TypedEventTarget.md#dispatchevent) - [removeEventListener](TypedEventTarget.md#removeeventlistener) ## Constructors ### constructor • **new TypedEventTarget**\<`Events`\>(): [`TypedEventTarget`](TypedEventTarget.md)\<`Events`\> #### Type parameters | Name | Type | | :------ | :------ | | `Events` | extends [`TypedCustomEvent`](TypedCustomEvent.md)\<`string`, `any`, `Events`\> = [`TypedCustomEvent`](TypedCustomEvent.md)\<`string`, `any`\> | #### Returns [`TypedEventTarget`](TypedEventTarget.md)\<`Events`\> ## Methods ### addEventListener ▸ **addEventListener**\<`K`\>(`type`, `callback`, `options?`): `void` #### Type parameters | Name | Type | | :------ | :------ | | `K` | extends `string` | #### Parameters | Name | Type | | :------ | :------ | | `type` | `K` | | `callback` | `TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\> | | `options?` | `TypedEventListenerOptions` | #### Returns `void` ___ ### dispatchEvent ▸ **dispatchEvent**(`event`): ``true`` #### Parameters | Name | Type | | :------ | :------ | | `event` | `Events` | #### Returns ``true`` ___ ### removeEventListener ▸ **removeEventListener**\<`K`\>(`type`, `callback`): `void` #### Type parameters | Name | Type | | :------ | :------ | | `K` | extends `string` | #### Parameters | Name | Type | | :------ | :------ | | `type` | `K` | | `callback` | `TypedEventListener`\<`EventOfType`\<`K`, `Events`\>\> | #### Returns `void`