-
-
Notifications
You must be signed in to change notification settings - Fork 35.5k
Expand file tree
/
Copy pathjs_native_api.h
More file actions
1245 lines (1081 loc) Β· 56.5 KB
/
js_native_api.h
File metadata and controls
1245 lines (1081 loc) Β· 56.5 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
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#ifndef SRC_JS_NATIVE_API_H_
#define SRC_JS_NATIVE_API_H_
#include "js_native_api_types.h"
// If you need __declspec(dllimport), either include <node_api.h> instead, or
// define NAPI_EXTERN as __declspec(dllimport) on the compiler's command line.
#ifndef NAPI_EXTERN
#ifdef _WIN32
#define NAPI_EXTERN __declspec(dllexport)
#elif defined(__wasm__)
#define NAPI_EXTERN \
__attribute__((visibility("default"))) \
__attribute__((__import_module__("napi")))
#else
#define NAPI_EXTERN __attribute__((visibility("default")))
#endif
#endif
#define NAPI_AUTO_LENGTH SIZE_MAX
#ifdef __cplusplus
#define EXTERN_C_START extern "C" {
#define EXTERN_C_END }
#else
#define EXTERN_C_START
#define EXTERN_C_END
#endif
#if defined(NODE_API_MODULE_USE_VTABLE) && \
!defined(NODE_API_MODULE_NO_VTABLE_IMPL)
#define NODE_API_MODULE_USE_VTABLE_IMPL
#endif
#ifdef NODE_API_MODULE_USE_VTABLE_IMPL
// Implement all Node-API functions via vtable indirection.
#undef NAPI_EXTERN
#define NAPI_EXTERN static inline
#ifndef NODE_API_MODULE_NO_VTABLE_FALLBACK
extern node_api_js_vtable g_node_api_js_vtable_fallback;
// Atomic pointer write with release semantics for thread-safe lazy init.
#ifndef NODE_API_WRITE_POINTER_RELEASE
// NOLINTBEGIN (readability/casting) - must be compilable by C compiler
#ifdef _MSC_VER
#include <intrin.h>
#define NODE_API_WRITE_POINTER_RELEASE(ptr, val) \
(void)_InterlockedExchangePointer((void* volatile*)(ptr), (void*)(val))
#else
#define NODE_API_WRITE_POINTER_RELEASE(ptr, val) \
__atomic_store_n((void**)(ptr), (void*)(val), __ATOMIC_RELEASE)
#endif
// NOLINTEND (readability/casting)
#endif // NODE_API_WRITE_POINTER_RELEASE
#ifndef NODE_API_LOAD_SYMBOL
#ifdef _WIN32
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#ifndef NOMINMAX
#define NOMINMAX
#endif
#include <windows.h>
// NOLINTBEGIN (readability/null_usage) - must be compilable by C compiler
static inline HMODULE node_api_get_runtime_module_handle(void) {
static HMODULE module_handle = NULL;
HMODULE handle = module_handle;
if (handle == NULL) {
// Match the code in win_delay_load_hook.cc from node-gyp.
handle = GetModuleHandleA("libnode.dll");
if (handle == NULL) {
handle = GetModuleHandleA(NULL);
}
NODE_API_WRITE_POINTER_RELEASE(&module_handle, handle);
}
return handle;
}
// NOLINTEND (readability/null_usage)
#define NODE_API_LOAD_SYMBOL(name) \
GetProcAddress(node_api_get_runtime_module_handle(), name)
#else
#include <dlfcn.h>
#define NODE_API_LOAD_SYMBOL(name) dlsym(RTLD_DEFAULT, name)
#endif // _WIN32
#endif // NODE_API_LOAD_SYMBOL
#define NODE_API_VTABLE_IMPL_FALLBACK( \
ret, vtable, func_name, method_name, ...) \
const node_api_##vtable* vtable = &g_node_api_##vtable##_fallback; \
if (!vtable->method_name) { \
NODE_API_WRITE_POINTER_RELEASE(&vtable->method_name, \
NODE_API_LOAD_SYMBOL(#func_name)); \
} \
ret vtable->method_name(__VA_ARGS__)
#else // NODE_API_MODULE_NO_VTABLE_FALLBACK
#ifndef NODE_API_UNREACHABLE
#ifdef _MSC_VER
#define NODE_API_UNREACHABLE() __fastfail(7 /* FAST_FAIL_FATAL_APP_EXIT */)
#else
#define NODE_API_UNREACHABLE() __builtin_trap()
#endif
#endif // NODE_API_UNREACHABLE
#define NODE_API_VTABLE_IMPL_FALLBACK(...) NODE_API_UNREACHABLE()
#endif // NODE_API_MODULE_NO_VTABLE_FALLBACK
#define NODE_API_VTABLE_IMPL_BASE(vtable, func_name, method_name, obj, ...) \
{ \
if (!obj) { \
return napi_invalid_arg; \
} else if (obj->sentinel == NODE_API_VT_SENTINEL) { \
return obj->vtable->method_name(__VA_ARGS__); \
} else { \
NODE_API_VTABLE_IMPL_FALLBACK( \
return, vtable, func_name, method_name, __VA_ARGS__); \
} \
}
#define NODE_API_JS_VTABLE_IMPL(func_name, method_name, env, ...) \
NODE_API_VTABLE_IMPL_BASE( \
js_vtable, func_name, method_name, env, env, __VA_ARGS__)
#else // NODE_API_MODULE_USE_VTABLE_IMPL
#define NODE_API_JS_VTABLE_IMPL(...)
#endif // NODE_API_MODULE_USE_VTABLE_IMPL
EXTERN_C_START
NAPI_EXTERN napi_status NAPI_CDECL napi_get_last_error_info(
node_api_basic_env env, const napi_extended_error_info** result)
NODE_API_JS_VTABLE_IMPL(napi_get_last_error_info,
get_last_error_info,
env,
result);
// Getters for defined singletons
NAPI_EXTERN napi_status NAPI_CDECL napi_get_undefined(napi_env env,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_get_undefined, get_undefined, env, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_null(napi_env env,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_get_null, get_null, env, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_global(napi_env env,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_get_global, get_global, env, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_boolean(napi_env env,
bool value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_get_boolean, get_boolean, env, value, result);
// Methods to create Primitive types/Objects
NAPI_EXTERN napi_status NAPI_CDECL napi_create_object(napi_env env,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_object, create_object, env, result);
#ifdef NAPI_EXPERIMENTAL
#define NODE_API_EXPERIMENTAL_HAS_CREATE_OBJECT_WITH_PROPERTIES
NAPI_EXTERN napi_status NAPI_CDECL
napi_create_object_with_properties(napi_env env,
napi_value prototype_or_null,
napi_value* property_names,
napi_value* property_values,
size_t property_count,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_object_with_properties,
create_object_with_properties,
env,
prototype_or_null,
property_names,
property_values,
property_count,
result);
#endif // NAPI_EXPERIMENTAL
NAPI_EXTERN napi_status NAPI_CDECL napi_create_array(napi_env env,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_array, create_array, env, result);
NAPI_EXTERN napi_status NAPI_CDECL
napi_create_array_with_length(napi_env env, size_t length, napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_array_with_length,
create_array_with_length,
env,
length,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_double(napi_env env,
double value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_double, create_double, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_int32(napi_env env,
int32_t value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_int32, create_int32, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_uint32(napi_env env,
uint32_t value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_uint32, create_uint32, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_int64(napi_env env,
int64_t value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_int64, create_int64, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_string_latin1(napi_env env,
const char* str,
size_t length,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_string_latin1,
create_string_latin1,
env,
str,
length,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_string_utf8(napi_env env,
const char* str,
size_t length,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_string_utf8, create_string_utf8, env, str, length, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_string_utf16(napi_env env,
const char16_t* str,
size_t length,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_string_utf16,
create_string_utf16,
env,
str,
length,
result);
#if NAPI_VERSION >= 10
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_external_string_latin1(
napi_env env,
char* str,
size_t length,
node_api_basic_finalize finalize_callback,
void* finalize_hint,
napi_value* result,
bool* copied)
NODE_API_JS_VTABLE_IMPL(node_api_create_external_string_latin1,
create_external_string_latin1,
env,
str,
length,
finalize_callback,
finalize_hint,
result,
copied);
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_external_string_utf16(
napi_env env,
char16_t* str,
size_t length,
node_api_basic_finalize finalize_callback,
void* finalize_hint,
napi_value* result,
bool* copied) NODE_API_JS_VTABLE_IMPL(node_api_create_external_string_utf16,
create_external_string_utf16,
env,
str,
length,
finalize_callback,
finalize_hint,
result,
copied);
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_property_key_latin1(
napi_env env, const char* str, size_t length, napi_value* result)
NODE_API_JS_VTABLE_IMPL(node_api_create_property_key_latin1,
create_property_key_latin1,
env,
str,
length,
result);
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_property_key_utf8(
napi_env env, const char* str, size_t length, napi_value* result)
NODE_API_JS_VTABLE_IMPL(node_api_create_property_key_utf8,
create_property_key_utf8,
env,
str,
length,
result);
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_property_key_utf16(
napi_env env, const char16_t* str, size_t length, napi_value* result)
NODE_API_JS_VTABLE_IMPL(node_api_create_property_key_utf16,
create_property_key_utf16,
env,
str,
length,
result);
#endif // NAPI_VERSION >= 10
NAPI_EXTERN napi_status NAPI_CDECL napi_create_symbol(napi_env env,
napi_value description,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_symbol, create_symbol, env, description, result);
#if NAPI_VERSION >= 9
NAPI_EXTERN napi_status NAPI_CDECL
node_api_symbol_for(napi_env env,
const char* utf8description,
size_t length,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
node_api_symbol_for, symbol_for, env, utf8description, length, result);
#endif // NAPI_VERSION >= 9
NAPI_EXTERN napi_status NAPI_CDECL napi_create_function(napi_env env,
const char* utf8name,
size_t length,
napi_callback cb,
void* data,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_function,
create_function,
env,
utf8name,
length,
cb,
data,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_error(napi_env env,
napi_value code,
napi_value msg,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_error, create_error, env, code, msg, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_type_error(napi_env env,
napi_value code,
napi_value msg,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_type_error, create_type_error, env, code, msg, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_range_error(napi_env env,
napi_value code,
napi_value msg,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_create_range_error, create_range_error, env, code, msg, result);
#if NAPI_VERSION >= 9
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_syntax_error(
napi_env env, napi_value code, napi_value msg, napi_value* result)
NODE_API_JS_VTABLE_IMPL(node_api_create_syntax_error,
create_syntax_error,
env,
code,
msg,
result);
#endif // NAPI_VERSION >= 9
// Methods to get the native napi_value from Primitive type
NAPI_EXTERN napi_status NAPI_CDECL napi_typeof(napi_env env,
napi_value value,
napi_valuetype* result)
NODE_API_JS_VTABLE_IMPL(napi_typeof, type_of, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_double(napi_env env,
napi_value value,
double* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_value_double, get_value_double, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_int32(napi_env env,
napi_value value,
int32_t* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_value_int32, get_value_int32, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_uint32(napi_env env,
napi_value value,
uint32_t* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_value_uint32, get_value_uint32, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_int64(napi_env env,
napi_value value,
int64_t* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_value_int64, get_value_int64, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_bool(napi_env env,
napi_value value,
bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_value_bool, get_value_bool, env, value, result);
// Copies LATIN-1 encoded bytes from a string into a buffer.
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_string_latin1(
napi_env env, napi_value value, char* buf, size_t bufsize, size_t* result)
NODE_API_JS_VTABLE_IMPL(napi_get_value_string_latin1,
get_value_string_latin1,
env,
value,
buf,
bufsize,
result);
// Copies UTF-8 encoded bytes from a string into a buffer.
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_string_utf8(
napi_env env, napi_value value, char* buf, size_t bufsize, size_t* result)
NODE_API_JS_VTABLE_IMPL(napi_get_value_string_utf8,
get_value_string_utf8,
env,
value,
buf,
bufsize,
result);
// Copies UTF-16 encoded bytes from a string into a buffer.
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_string_utf16(napi_env env,
napi_value value,
char16_t* buf,
size_t bufsize,
size_t* result)
NODE_API_JS_VTABLE_IMPL(napi_get_value_string_utf16,
get_value_string_utf16,
env,
value,
buf,
bufsize,
result);
// Methods to coerce values
// These APIs may execute user scripts
NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_bool(napi_env env,
napi_value value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_coerce_to_bool, coerce_to_bool, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_number(napi_env env,
napi_value value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_coerce_to_number, coerce_to_number, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_object(napi_env env,
napi_value value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_coerce_to_object, coerce_to_object, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_coerce_to_string(napi_env env,
napi_value value,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_coerce_to_string, coerce_to_string, env, value, result);
// Methods to work with Objects
#ifdef NAPI_EXPERIMENTAL
#define NODE_API_EXPERIMENTAL_HAS_SET_PROTOTYPE
NAPI_EXTERN napi_status NAPI_CDECL node_api_set_prototype(napi_env env,
napi_value object,
napi_value value)
NODE_API_JS_VTABLE_IMPL(
node_api_set_prototype, set_prototype, env, object, value);
#endif
NAPI_EXTERN napi_status NAPI_CDECL napi_get_prototype(napi_env env,
napi_value object,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_prototype, get_prototype, env, object, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_property_names(napi_env env,
napi_value object,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_property_names, get_property_names, env, object, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_set_property(napi_env env,
napi_value object,
napi_value key,
napi_value value)
NODE_API_JS_VTABLE_IMPL(
napi_set_property, set_property, env, object, key, value);
NAPI_EXTERN napi_status NAPI_CDECL
napi_has_property(napi_env env, napi_value object, napi_value key, bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_has_property, has_property, env, object, key, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_property(napi_env env,
napi_value object,
napi_value key,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_property, get_property, env, object, key, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_delete_property(napi_env env,
napi_value object,
napi_value key,
bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_delete_property, delete_property, env, object, key, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_has_own_property(napi_env env,
napi_value object,
napi_value key,
bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_has_own_property, has_own_property, env, object, key, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_set_named_property(napi_env env,
napi_value object,
const char* utf8name,
napi_value value)
NODE_API_JS_VTABLE_IMPL(napi_set_named_property,
set_named_property,
env,
object,
utf8name,
value);
NAPI_EXTERN napi_status NAPI_CDECL napi_has_named_property(napi_env env,
napi_value object,
const char* utf8name,
bool* result)
NODE_API_JS_VTABLE_IMPL(napi_has_named_property,
has_named_property,
env,
object,
utf8name,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_named_property(napi_env env,
napi_value object,
const char* utf8name,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_get_named_property,
get_named_property,
env,
object,
utf8name,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_set_element(napi_env env,
napi_value object,
uint32_t index,
napi_value value)
NODE_API_JS_VTABLE_IMPL(
napi_set_element, set_element, env, object, index, value);
NAPI_EXTERN napi_status NAPI_CDECL
napi_has_element(napi_env env, napi_value object, uint32_t index, bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_has_element, has_element, env, object, index, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_element(napi_env env,
napi_value object,
uint32_t index,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_element, get_element, env, object, index, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_delete_element(napi_env env,
napi_value object,
uint32_t index,
bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_delete_element, delete_element, env, object, index, result);
NAPI_EXTERN napi_status NAPI_CDECL
napi_define_properties(napi_env env,
napi_value object,
size_t property_count,
const napi_property_descriptor* properties)
NODE_API_JS_VTABLE_IMPL(napi_define_properties,
define_properties,
env,
object,
property_count,
properties);
// Methods to work with Arrays
NAPI_EXTERN napi_status NAPI_CDECL napi_is_array(napi_env env,
napi_value value,
bool* result)
NODE_API_JS_VTABLE_IMPL(napi_is_array, is_array, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_array_length(napi_env env,
napi_value value,
uint32_t* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_array_length, get_array_length, env, value, result);
// Methods to compare values
NAPI_EXTERN napi_status NAPI_CDECL
napi_strict_equals(napi_env env, napi_value lhs, napi_value rhs, bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_strict_equals, strict_equals, env, lhs, rhs, result);
// Methods to work with Functions
NAPI_EXTERN napi_status NAPI_CDECL napi_call_function(napi_env env,
napi_value recv,
napi_value func,
size_t argc,
const napi_value* argv,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_call_function, call_function, env, recv, func, argc, argv, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_new_instance(napi_env env,
napi_value constructor,
size_t argc,
const napi_value* argv,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_new_instance, new_instance, env, constructor, argc, argv, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_instanceof(napi_env env,
napi_value object,
napi_value constructor,
bool* result)
NODE_API_JS_VTABLE_IMPL(napi_instanceof,
instanceof
, env, object, constructor, result);
// Methods to work with napi_callbacks
// Gets all callback info in a single call. (Ugly, but faster.)
NAPI_EXTERN napi_status NAPI_CDECL napi_get_cb_info(
napi_env env, // [in] Node-API environment handle
napi_callback_info cbinfo, // [in] Opaque callback-info handle
size_t* argc, // [in-out] Specifies the size of the provided argv array
// and receives the actual count of args.
napi_value* argv, // [out] Array of values
napi_value* this_arg, // [out] Receives the JS 'this' arg for the call
void** data) // [out] Receives the data pointer for the callback.
NODE_API_JS_VTABLE_IMPL(
napi_get_cb_info, get_cb_info, env, cbinfo, argc, argv, this_arg, data);
NAPI_EXTERN napi_status NAPI_CDECL
napi_get_new_target(napi_env env, napi_callback_info cbinfo, napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_new_target, get_new_target, env, cbinfo, result);
NAPI_EXTERN napi_status NAPI_CDECL
napi_define_class(napi_env env,
const char* utf8name,
size_t length,
napi_callback constructor,
void* data,
size_t property_count,
const napi_property_descriptor* properties,
napi_value* result) NODE_API_JS_VTABLE_IMPL(napi_define_class,
define_class,
env,
utf8name,
length,
constructor,
data,
property_count,
properties,
result);
// Methods to work with external data objects
NAPI_EXTERN napi_status NAPI_CDECL
napi_wrap(napi_env env,
napi_value js_object,
void* native_object,
node_api_basic_finalize finalize_cb,
void* finalize_hint,
napi_ref* result) NODE_API_JS_VTABLE_IMPL(napi_wrap,
wrap,
env,
js_object,
native_object,
finalize_cb,
finalize_hint,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_unwrap(napi_env env,
napi_value js_object,
void** result)
NODE_API_JS_VTABLE_IMPL(napi_unwrap, unwrap, env, js_object, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_remove_wrap(napi_env env,
napi_value js_object,
void** result)
NODE_API_JS_VTABLE_IMPL(
napi_remove_wrap, remove_wrap, env, js_object, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_external(
napi_env env,
void* data,
node_api_basic_finalize finalize_cb,
void* finalize_hint,
napi_value* result) NODE_API_JS_VTABLE_IMPL(napi_create_external,
create_external,
env,
data,
finalize_cb,
finalize_hint,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_value_external(napi_env env,
napi_value value,
void** result)
NODE_API_JS_VTABLE_IMPL(
napi_get_value_external, get_value_external, env, value, result);
// Methods to control object lifespan
// Set initial_refcount to 0 for a weak reference, >0 for a strong reference.
NAPI_EXTERN napi_status NAPI_CDECL napi_create_reference(
napi_env env, napi_value value, uint32_t initial_refcount, napi_ref* result)
NODE_API_JS_VTABLE_IMPL(napi_create_reference,
create_reference,
env,
value,
initial_refcount,
result);
// Deletes a reference. The referenced value is released, and may
// be GC'd unless there are other references to it.
NAPI_EXTERN napi_status NAPI_CDECL napi_delete_reference(node_api_basic_env env,
napi_ref ref)
NODE_API_JS_VTABLE_IMPL(napi_delete_reference, delete_reference, env, ref);
// Increments the reference count, optionally returning the resulting count.
// After this call the reference will be a strong reference because its
// refcount is >0, and the referenced object is effectively "pinned".
// Calling this when the refcount is 0 and the object is unavailable
// results in an error.
NAPI_EXTERN napi_status NAPI_CDECL napi_reference_ref(napi_env env,
napi_ref ref,
uint32_t* result)
NODE_API_JS_VTABLE_IMPL(
napi_reference_ref, reference_ref, env, ref, result);
// Decrements the reference count, optionally returning the resulting count.
// If the result is 0 the reference is now weak and the object may be GC'd
// at any time if there are no other references. Calling this when the
// refcount is already 0 results in an error.
NAPI_EXTERN napi_status NAPI_CDECL napi_reference_unref(napi_env env,
napi_ref ref,
uint32_t* result)
NODE_API_JS_VTABLE_IMPL(
napi_reference_unref, reference_unref, env, ref, result);
// Attempts to get a referenced value. If the reference is weak,
// the value might no longer be available, in that case the call
// is still successful but the result is NULL.
NAPI_EXTERN napi_status NAPI_CDECL napi_get_reference_value(napi_env env,
napi_ref ref,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_get_reference_value, get_reference_value, env, ref, result);
NAPI_EXTERN napi_status NAPI_CDECL
napi_open_handle_scope(napi_env env, napi_handle_scope* result)
NODE_API_JS_VTABLE_IMPL(napi_open_handle_scope,
open_handle_scope,
env,
result);
NAPI_EXTERN napi_status NAPI_CDECL
napi_close_handle_scope(napi_env env, napi_handle_scope scope)
NODE_API_JS_VTABLE_IMPL(napi_close_handle_scope,
close_handle_scope,
env,
scope);
NAPI_EXTERN napi_status NAPI_CDECL napi_open_escapable_handle_scope(
napi_env env, napi_escapable_handle_scope* result)
NODE_API_JS_VTABLE_IMPL(napi_open_escapable_handle_scope,
open_escapable_handle_scope,
env,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_close_escapable_handle_scope(
napi_env env, napi_escapable_handle_scope scope)
NODE_API_JS_VTABLE_IMPL(napi_close_escapable_handle_scope,
close_escapable_handle_scope,
env,
scope);
NAPI_EXTERN napi_status NAPI_CDECL
napi_escape_handle(napi_env env,
napi_escapable_handle_scope scope,
napi_value escapee,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(
napi_escape_handle, escape_handle, env, scope, escapee, result);
// Methods to support error handling
NAPI_EXTERN napi_status NAPI_CDECL napi_throw(napi_env env, napi_value error)
NODE_API_JS_VTABLE_IMPL(napi_throw, throw_value, env, error);
NAPI_EXTERN napi_status NAPI_CDECL napi_throw_error(napi_env env,
const char* code,
const char* msg)
NODE_API_JS_VTABLE_IMPL(napi_throw_error, throw_error, env, code, msg);
NAPI_EXTERN napi_status NAPI_CDECL napi_throw_type_error(napi_env env,
const char* code,
const char* msg)
NODE_API_JS_VTABLE_IMPL(
napi_throw_type_error, throw_type_error, env, code, msg);
NAPI_EXTERN napi_status NAPI_CDECL napi_throw_range_error(napi_env env,
const char* code,
const char* msg)
NODE_API_JS_VTABLE_IMPL(
napi_throw_range_error, throw_range_error, env, code, msg);
#if NAPI_VERSION >= 9
NAPI_EXTERN napi_status NAPI_CDECL node_api_throw_syntax_error(napi_env env,
const char* code,
const char* msg)
NODE_API_JS_VTABLE_IMPL(
node_api_throw_syntax_error, throw_syntax_error, env, code, msg);
#endif // NAPI_VERSION >= 9
NAPI_EXTERN napi_status NAPI_CDECL napi_is_error(napi_env env,
napi_value value,
bool* result)
NODE_API_JS_VTABLE_IMPL(napi_is_error, is_error, env, value, result);
// Methods to support catching exceptions
NAPI_EXTERN napi_status NAPI_CDECL napi_is_exception_pending(napi_env env,
bool* result)
NODE_API_JS_VTABLE_IMPL(napi_is_exception_pending,
is_exception_pending,
env,
result);
NAPI_EXTERN napi_status NAPI_CDECL
napi_get_and_clear_last_exception(napi_env env, napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_get_and_clear_last_exception,
get_and_clear_last_exception,
env,
result);
// Methods to work with array buffers and typed arrays
NAPI_EXTERN napi_status NAPI_CDECL napi_is_arraybuffer(napi_env env,
napi_value value,
bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_is_arraybuffer, is_arraybuffer, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_arraybuffer(napi_env env,
size_t byte_length,
void** data,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_arraybuffer,
create_arraybuffer,
env,
byte_length,
data,
result);
#ifndef NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
NAPI_EXTERN napi_status NAPI_CDECL
napi_create_external_arraybuffer(napi_env env,
void* external_data,
size_t byte_length,
node_api_basic_finalize finalize_cb,
void* finalize_hint,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_external_arraybuffer,
create_external_arraybuffer,
env,
external_data,
byte_length,
finalize_cb,
finalize_hint,
result);
#endif // NODE_API_NO_EXTERNAL_BUFFERS_ALLOWED
NAPI_EXTERN napi_status NAPI_CDECL napi_get_arraybuffer_info(
napi_env env, napi_value arraybuffer, void** data, size_t* byte_length)
NODE_API_JS_VTABLE_IMPL(napi_get_arraybuffer_info,
get_arraybuffer_info,
env,
arraybuffer,
data,
byte_length);
NAPI_EXTERN napi_status NAPI_CDECL napi_is_typedarray(napi_env env,
napi_value value,
bool* result)
NODE_API_JS_VTABLE_IMPL(
napi_is_typedarray, is_typedarray, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_typedarray(
napi_env env,
napi_typedarray_type type,
size_t length,
napi_value arraybuffer,
size_t byte_offset,
napi_value* result) NODE_API_JS_VTABLE_IMPL(napi_create_typedarray,
create_typedarray,
env,
type,
length,
arraybuffer,
byte_offset,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_typedarray_info(
napi_env env,
napi_value typedarray,
napi_typedarray_type* type,
size_t* length,
void** data,
napi_value* arraybuffer,
size_t* byte_offset) NODE_API_JS_VTABLE_IMPL(napi_get_typedarray_info,
get_typedarray_info,
env,
typedarray,
type,
length,
data,
arraybuffer,
byte_offset);
NAPI_EXTERN napi_status NAPI_CDECL napi_create_dataview(napi_env env,
size_t length,
napi_value arraybuffer,
size_t byte_offset,
napi_value* result)
NODE_API_JS_VTABLE_IMPL(napi_create_dataview,
create_dataview,
env,
length,
arraybuffer,
byte_offset,
result);
NAPI_EXTERN napi_status NAPI_CDECL napi_is_dataview(napi_env env,
napi_value value,
bool* result)
NODE_API_JS_VTABLE_IMPL(napi_is_dataview, is_dataview, env, value, result);
NAPI_EXTERN napi_status NAPI_CDECL napi_get_dataview_info(
napi_env env,
napi_value dataview,
size_t* bytelength,
void** data,
napi_value* arraybuffer,
size_t* byte_offset) NODE_API_JS_VTABLE_IMPL(napi_get_dataview_info,
get_dataview_info,
env,
dataview,
bytelength,
data,
arraybuffer,
byte_offset);
#ifdef NAPI_EXPERIMENTAL
#define NODE_API_EXPERIMENTAL_HAS_SHAREDARRAYBUFFER
NAPI_EXTERN napi_status NAPI_CDECL
node_api_is_sharedarraybuffer(napi_env env, napi_value value, bool* result)
NODE_API_JS_VTABLE_IMPL(node_api_is_sharedarraybuffer,
is_sharedarraybuffer,
env,
value,
result);
NAPI_EXTERN napi_status NAPI_CDECL node_api_create_sharedarraybuffer(
napi_env env, size_t byte_length, void** data, napi_value* result)
NODE_API_JS_VTABLE_IMPL(node_api_create_sharedarraybuffer,
create_sharedarraybuffer,
env,
byte_length,
data,
result);
#endif // NAPI_EXPERIMENTAL