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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
|
# InstanceWrap<T>
This class serves as the base class for [`Napi::ObjectWrap<T>`][] and
[`Napi::Addon<T>`][].
In the case of [`Napi::Addon<T>`][] it provides the
methods for exposing functions to JavaScript on instances of an add-on.
As a base class for [`Napi::ObjectWrap<T>`][] it provides the methods for
exposing instance methods of JavaScript objects instantiated from the JavaScript
class corresponding to the subclass of [`Napi::ObjectWrap<T>`][].
## Methods
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
InstanceVoidMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] utf8name`: Null-terminated string that represents the name of the method
provided by instances of the class.
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
void MethodName(const Napi::CallbackInfo& info);
```
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
InstanceMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] utf8name`: Null-terminated string that represents the name of the method
provided by instances of the class.
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
Napi::Value MethodName(const Napi::CallbackInfo& info);
```
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
InstanceVoidMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] name`: JavaScript symbol that represents the name of the method provided
by instances of the class.
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
void MethodName(const Napi::CallbackInfo& info);
```
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
InstanceMethodCallback method,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] name`: JavaScript symbol that represents the name of the method provided
by instances of the class.
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
Napi::Value MethodName(const Napi::CallbackInfo& info);
```
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
<template typename T>
template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap::InstanceMethod(const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] utf8name`: Null-terminated string that represents the name of the method
provided by instances of the class.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
void MethodName(const Napi::CallbackInfo& info);
```
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
template <typename T>
template <typename InstanceWrap<T>::InstanceMethodCallback method>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceMethod(const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] utf8name`: Null-terminated string that represents the name of the method
provided by instances of the class.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
Napi::Value MethodName(const Napi::CallbackInfo& info);
```
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
template <typename T>
template <typename InstanceWrap<T>::InstanceVoidMethodCallback method>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
instance method for the class.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
void MethodName(const Napi::CallbackInfo& info);
```
### InstanceMethod
Creates a property descriptor that represents a method exposed on JavaScript
instances of this class.
```cpp
template <typename T>
template <InstanceWrap<T>::InstanceMethodCallback method>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceMethod(Napi::Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] method`: The native function that represents a method provided by the
add-on.
- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
instance method for the class.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the method when it is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents a method
provided by instances of the class. The method must be of the form
```cpp
Napi::Value MethodName(const Napi::CallbackInfo& info);
```
### InstanceAccessor
Creates a property descriptor that represents a property exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceAccessor(const char* utf8name,
InstanceGetterCallback getter,
InstanceSetterCallback setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] utf8name`: Null-terminated string that represents the name of the method
provided by instances of the class.
- `[in] getter`: The native function to call when a get access to the property
is performed.
- `[in] setter`: The native function to call when a set access to the property
is performed.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the getter or the setter when it
is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
accessor property provided by instances of the class.
### InstanceAccessor
Creates a property descriptor that represents a property exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceAccessor(Symbol name,
InstanceGetterCallback getter,
InstanceSetterCallback setter,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
instance accessor.
- `[in] getter`: The native function to call when a get access to the property of
a JavaScript class is performed.
- `[in] setter`: The native function to call when a set access to the property of
a JavaScript class is performed.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the getter or the setter when it
is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
accessor property provided instances of the class.
### InstanceAccessor
Creates a property descriptor that represents a property exposed on JavaScript
instances of this class.
```cpp
template <typename T>
template <typename InstanceWrap<T>::InstanceGetterCallback getter,
typename InstanceWrap<T>::InstanceSetterCallback setter=nullptr>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceAccessor(const char* utf8name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] getter`: The native function to call when a get access to the property of
a JavaScript class is performed.
- `[in] setter`: The native function to call when a set access to the property of
a JavaScript class is performed.
- `[in] utf8name`: Null-terminated string that represents the name of the method
provided by instances of the class.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the getter or the setter when it
is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
accessor property provided by instances of the class.
### InstanceAccessor
Creates a property descriptor that represents a property exposed on JavaScript
instances of this class.
```cpp
template <typename T>
template <typename InstanceWrap<T>::InstanceGetterCallback getter,
typename InstanceWrap<T>::InstanceSetterCallback setter=nullptr>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceAccessor(Symbol name,
napi_property_attributes attributes = napi_default,
void* data = nullptr);
```
- `[in] getter`: The native function to call when a get access to the property of
a JavaScript class is performed.
- `[in] setter`: The native function to call when a set access to the property of
a JavaScript class is performed.
- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
instance accessor.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
- `[in] data`: User-provided data passed into the getter or the setter when it
is invoked.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
accessor property provided by instances of the class.
### InstanceValue
Creates property descriptor that represents a value exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceValue(const char* utf8name,
Napi::Value value,
napi_property_attributes attributes = napi_default);
```
- `[in] utf8name`: Null-terminated string that represents the name of the
property.
- `[in] value`: The value that's retrieved by a get access of the property.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
value property of an add-on.
### InstanceValue
Creates property descriptor that represents a value exposed on JavaScript
instances of this class.
```cpp
template <typename T>
static Napi::ClassPropertyDescriptor<T>
Napi::InstanceWrap<T>::InstanceValue(Symbol name,
Napi::Value value,
napi_property_attributes attributes = napi_default);
```
- `[in] name`: The `Napi::Symbol` object whose value is used to identify the
name of the property.
- `[in] value`: The value that's retrieved by a get access of the property.
- `[in] attributes`: The attributes associated with the property. One or more of
`napi_property_attributes`.
Returns a `Napi::ClassPropertyDescriptor<T>` object that represents an instance
value property of an add-on.
[`Napi::Addon<T>`]: ./addon.md
[`Napi::ObjectWrap<T>`]: ./object_wrap.md
|
