@contrast/agent 4.5.1 → 4.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (209) hide show
  1. package/bin/VERSION +1 -1
  2. package/bin/linux/contrast-service +0 -0
  3. package/bin/mac/contrast-service +0 -0
  4. package/bin/windows/contrast-service.exe +0 -0
  5. package/lib/assess/membrane/deserialization-membrane.js +4 -5
  6. package/lib/assess/membrane/source-membrane.js +16 -33
  7. package/lib/assess/models/call-context.js +1 -1
  8. package/lib/assess/policy/propagators.json +19 -21
  9. package/lib/assess/policy/rules.json +7 -2
  10. package/lib/assess/policy/signatures.json +42 -0
  11. package/lib/assess/policy/util.js +2 -1
  12. package/lib/assess/propagators/JSON/parse.js +1 -1
  13. package/lib/assess/propagators/JSON/stringify.js +3 -3
  14. package/lib/assess/propagators/array-prototype-join.js +7 -8
  15. package/lib/assess/propagators/common.js +7 -5
  16. package/lib/assess/propagators/dustjs/escape-html.js +22 -0
  17. package/lib/assess/propagators/dustjs/escape-js.js +22 -0
  18. package/lib/assess/propagators/encode-uri/encode-uri-component.js +22 -0
  19. package/lib/assess/propagators/encode-uri/encode-uri.js +22 -0
  20. package/lib/assess/propagators/handlebars-escape-expresssion.js +1 -1
  21. package/lib/assess/propagators/index.js +0 -2
  22. package/lib/assess/propagators/joi/boolean.js +1 -1
  23. package/lib/assess/propagators/joi/expression.js +1 -1
  24. package/lib/assess/propagators/joi/number.js +1 -1
  25. package/lib/assess/propagators/joi/string-base.js +1 -1
  26. package/lib/assess/propagators/joi/string-schema.js +12 -13
  27. package/lib/assess/propagators/joi/values.js +37 -22
  28. package/lib/assess/propagators/manager.js +12 -10
  29. package/lib/assess/propagators/mongoose/helpers.js +20 -0
  30. package/lib/assess/propagators/mongoose/index.js +18 -0
  31. package/lib/assess/propagators/mongoose/map.js +74 -0
  32. package/lib/assess/propagators/mongoose/string.js +104 -0
  33. package/lib/assess/propagators/mustache/escape.js +22 -0
  34. package/lib/assess/propagators/number.js +54 -0
  35. package/lib/assess/propagators/object.js +6 -7
  36. package/lib/assess/propagators/path/basename.js +14 -13
  37. package/lib/assess/propagators/path/common.js +156 -47
  38. package/lib/assess/propagators/path/dirname.js +14 -13
  39. package/lib/assess/propagators/path/extname.js +14 -13
  40. package/lib/assess/propagators/path/join.js +5 -1
  41. package/lib/assess/propagators/path/normalize.js +1 -2
  42. package/lib/assess/propagators/path/parse.js +1 -1
  43. package/lib/assess/propagators/path/relative.js +7 -5
  44. package/lib/assess/propagators/path/resolve.js +11 -2
  45. package/lib/assess/propagators/querystring/escape.js +20 -18
  46. package/lib/assess/propagators/querystring/parse.js +7 -5
  47. package/lib/assess/propagators/querystring/stringify.js +25 -24
  48. package/lib/assess/propagators/querystring/unescape.js +20 -18
  49. package/lib/assess/propagators/sequelize/sql-string-escape.js +1 -1
  50. package/lib/assess/propagators/sequelize/sql-string-format-named-parameters.js +1 -1
  51. package/lib/assess/propagators/sequelize/sql-string-format.js +3 -3
  52. package/lib/assess/propagators/sequelize/utils.js +2 -2
  53. package/lib/assess/propagators/string-prototype-replace.js +30 -28
  54. package/lib/assess/propagators/string-prototype-split.js +36 -36
  55. package/lib/assess/propagators/string-prototype-trim.js +15 -17
  56. package/lib/assess/propagators/string.js +12 -16
  57. package/lib/assess/propagators/template-escape.js +87 -0
  58. package/lib/assess/propagators/templates.js +10 -11
  59. package/lib/assess/propagators/url/url-prototype-parse.js +5 -6
  60. package/lib/assess/propagators/url/url-url.js +51 -43
  61. package/lib/assess/propagators/util/format.js +1 -1
  62. package/lib/assess/propagators/v8/init-hooks.js +3 -3
  63. package/lib/assess/propagators/validator/init-hooks.js +22 -22
  64. package/lib/assess/sinks/common.js +10 -5
  65. package/lib/assess/sinks/dustjs-linkedin-xss.js +131 -0
  66. package/lib/assess/sinks/libxmljs-xxe.js +1 -1
  67. package/lib/assess/sinks/mongodb.js +2 -1
  68. package/lib/assess/sinks/ssrf-url.js +1 -1
  69. package/lib/constants.js +4 -1
  70. package/lib/core/arch-components/dynamodb.js +1 -2
  71. package/lib/core/arch-components/dynamodbv3.js +44 -0
  72. package/lib/core/arch-components/index.js +1 -0
  73. package/lib/core/arch-components/rethinkdb.js +53 -0
  74. package/lib/core/config/options.js +3 -2
  75. package/lib/core/rewrite/injections.js +8 -0
  76. package/lib/core/stacktrace.js +2 -1
  77. package/lib/feature-set.js +1 -1
  78. package/lib/hooks/frameworks/base.js +8 -2
  79. package/lib/hooks/frameworks/http.js +23 -16
  80. package/lib/hooks/frameworks/http2.js +73 -0
  81. package/lib/hooks/frameworks/index.js +8 -3
  82. package/lib/hooks/http.js +112 -128
  83. package/lib/hooks/object-to-primitive.js +6 -7
  84. package/lib/hooks/patcher.js +75 -44
  85. package/lib/hooks/require.js +16 -22
  86. package/lib/instrumentation.js +0 -3
  87. package/lib/protect/rules/nosqli/nosql-injection-rule.js +228 -0
  88. package/lib/protect/rules/rule-factory.js +2 -2
  89. package/lib/protect/service.js +23 -11
  90. package/lib/protect/sinks/mongodb.js +56 -55
  91. package/lib/reporter/translations/to-protobuf/dtm/index.js +1 -1
  92. package/lib/reporter/translations/to-protobuf/dtm/ip-denylist-details.js +1 -1
  93. package/lib/reporter/translations/to-protobuf/dtm/rasp-rule-sample.js +1 -1
  94. package/lib/reporter/translations/to-protobuf/settings/defend-features.js +8 -6
  95. package/lib/reporter/translations/to-protobuf/settings/exclusions.js +5 -4
  96. package/lib/tracker.js +13 -65
  97. package/lib/util/some.js +27 -0
  98. package/lib/util/source-map.js +1 -1
  99. package/package.json +15 -16
  100. package/lib/hooks/frameworks/https.js +0 -42
  101. package/lib/protect/rules/nosqli/no-sql-injection-rule.js +0 -109
  102. package/node_modules/bindings/LICENSE.md +0 -22
  103. package/node_modules/bindings/README.md +0 -98
  104. package/node_modules/bindings/bindings.js +0 -221
  105. package/node_modules/bindings/package.json +0 -32
  106. package/node_modules/file-uri-to-path/.npmignore +0 -1
  107. package/node_modules/file-uri-to-path/.travis.yml +0 -30
  108. package/node_modules/file-uri-to-path/History.md +0 -21
  109. package/node_modules/file-uri-to-path/LICENSE +0 -20
  110. package/node_modules/file-uri-to-path/README.md +0 -74
  111. package/node_modules/file-uri-to-path/index.d.ts +0 -2
  112. package/node_modules/file-uri-to-path/index.js +0 -66
  113. package/node_modules/file-uri-to-path/package.json +0 -36
  114. package/node_modules/file-uri-to-path/test/test.js +0 -24
  115. package/node_modules/file-uri-to-path/test/tests.json +0 -13
  116. package/node_modules/glossy/LICENSE +0 -19
  117. package/node_modules/glossy/README.md +0 -129
  118. package/node_modules/glossy/index.js +0 -12
  119. package/node_modules/glossy/lib/glossy/parse.js +0 -520
  120. package/node_modules/glossy/lib/glossy/produce.js +0 -459
  121. package/node_modules/glossy/package.json +0 -47
  122. package/node_modules/glossy/test/decide.js +0 -7
  123. package/node_modules/glossy/test/decode_pri.js +0 -24
  124. package/node_modules/glossy/test/parse_3164.js +0 -104
  125. package/node_modules/glossy/test/parse_5424.js +0 -106
  126. package/node_modules/glossy/test/parse_5848.js +0 -40
  127. package/node_modules/glossy/test/parse_8601.js +0 -14
  128. package/node_modules/glossy/test/parse_rfc3339.js +0 -9
  129. package/node_modules/glossy/test/produce.js +0 -162
  130. package/node_modules/glossy/test/runner.js +0 -40
  131. package/node_modules/glossy/test/structure_data.js +0 -24
  132. package/node_modules/nan/CHANGELOG.md +0 -537
  133. package/node_modules/nan/LICENSE.md +0 -13
  134. package/node_modules/nan/README.md +0 -455
  135. package/node_modules/nan/doc/asyncworker.md +0 -146
  136. package/node_modules/nan/doc/buffers.md +0 -54
  137. package/node_modules/nan/doc/callback.md +0 -76
  138. package/node_modules/nan/doc/converters.md +0 -41
  139. package/node_modules/nan/doc/errors.md +0 -226
  140. package/node_modules/nan/doc/json.md +0 -62
  141. package/node_modules/nan/doc/maybe_types.md +0 -583
  142. package/node_modules/nan/doc/methods.md +0 -664
  143. package/node_modules/nan/doc/new.md +0 -147
  144. package/node_modules/nan/doc/node_misc.md +0 -123
  145. package/node_modules/nan/doc/object_wrappers.md +0 -263
  146. package/node_modules/nan/doc/persistent.md +0 -296
  147. package/node_modules/nan/doc/scopes.md +0 -73
  148. package/node_modules/nan/doc/script.md +0 -38
  149. package/node_modules/nan/doc/string_bytes.md +0 -62
  150. package/node_modules/nan/doc/v8_internals.md +0 -199
  151. package/node_modules/nan/doc/v8_misc.md +0 -85
  152. package/node_modules/nan/include_dirs.js +0 -1
  153. package/node_modules/nan/nan.h +0 -2898
  154. package/node_modules/nan/nan_callbacks.h +0 -88
  155. package/node_modules/nan/nan_callbacks_12_inl.h +0 -514
  156. package/node_modules/nan/nan_callbacks_pre_12_inl.h +0 -520
  157. package/node_modules/nan/nan_converters.h +0 -72
  158. package/node_modules/nan/nan_converters_43_inl.h +0 -68
  159. package/node_modules/nan/nan_converters_pre_43_inl.h +0 -42
  160. package/node_modules/nan/nan_define_own_property_helper.h +0 -29
  161. package/node_modules/nan/nan_implementation_12_inl.h +0 -430
  162. package/node_modules/nan/nan_implementation_pre_12_inl.h +0 -263
  163. package/node_modules/nan/nan_json.h +0 -166
  164. package/node_modules/nan/nan_maybe_43_inl.h +0 -356
  165. package/node_modules/nan/nan_maybe_pre_43_inl.h +0 -268
  166. package/node_modules/nan/nan_new.h +0 -340
  167. package/node_modules/nan/nan_object_wrap.h +0 -156
  168. package/node_modules/nan/nan_persistent_12_inl.h +0 -132
  169. package/node_modules/nan/nan_persistent_pre_12_inl.h +0 -242
  170. package/node_modules/nan/nan_private.h +0 -73
  171. package/node_modules/nan/nan_string_bytes.h +0 -305
  172. package/node_modules/nan/nan_typedarray_contents.h +0 -96
  173. package/node_modules/nan/nan_weak.h +0 -437
  174. package/node_modules/nan/package.json +0 -41
  175. package/node_modules/nan/tools/1to2.js +0 -412
  176. package/node_modules/nan/tools/README.md +0 -14
  177. package/node_modules/nan/tools/package.json +0 -19
  178. package/node_modules/unix-dgram/LICENSE +0 -13
  179. package/node_modules/unix-dgram/README.md +0 -107
  180. package/node_modules/unix-dgram/binding.gyp +0 -20
  181. package/node_modules/unix-dgram/build/Makefile +0 -324
  182. package/node_modules/unix-dgram/build/Release/.deps/Release/obj.target/unix_dgram/src/unix_dgram.o.d +0 -58
  183. package/node_modules/unix-dgram/build/Release/.deps/Release/obj.target/unix_dgram.node.d +0 -1
  184. package/node_modules/unix-dgram/build/Release/.deps/Release/unix_dgram.node.d +0 -1
  185. package/node_modules/unix-dgram/build/Release/obj.target/unix_dgram/src/unix_dgram.o +0 -0
  186. package/node_modules/unix-dgram/build/Release/obj.target/unix_dgram.node +0 -0
  187. package/node_modules/unix-dgram/build/Release/unix_dgram.node +0 -0
  188. package/node_modules/unix-dgram/build/binding.Makefile +0 -6
  189. package/node_modules/unix-dgram/build/config.gypi +0 -213
  190. package/node_modules/unix-dgram/build/unix_dgram.target.mk +0 -159
  191. package/node_modules/unix-dgram/lib/unix_dgram.js +0 -168
  192. package/node_modules/unix-dgram/package.json +0 -36
  193. package/node_modules/unix-dgram/src/unix_dgram.cc +0 -404
  194. package/node_modules/unix-dgram/src/win_dummy.cc +0 -7
  195. package/node_modules/unix-dgram/test/test-connect-callback.js +0 -68
  196. package/node_modules/unix-dgram/test/test-connect.js +0 -53
  197. package/node_modules/unix-dgram/test/test-dgram-unix.js +0 -58
  198. package/node_modules/unix-dgram/test/test-send-error.js +0 -26
  199. package/node_modules/winston-syslog/.eslintrc +0 -7
  200. package/node_modules/winston-syslog/.travis.yml +0 -14
  201. package/node_modules/winston-syslog/CHANGELOG.md +0 -9
  202. package/node_modules/winston-syslog/LICENSE +0 -20
  203. package/node_modules/winston-syslog/README.md +0 -135
  204. package/node_modules/winston-syslog/lib/utils.js +0 -26
  205. package/node_modules/winston-syslog/lib/winston-syslog.js +0 -385
  206. package/node_modules/winston-syslog/package.json +0 -56
  207. package/node_modules/winston-syslog/test/format-test.js +0 -122
  208. package/node_modules/winston-syslog/test/syslog-test.js +0 -95
  209. package/node_modules/winston-syslog/test/unix-connect-test.js +0 -133
@@ -1,664 +0,0 @@
1
- ## JavaScript-accessible methods
2
-
3
- A _template_ is a blueprint for JavaScript functions and objects in a context. You can use a template to wrap C++ functions and data structures within JavaScript objects so that they can be manipulated from JavaScript. See the V8 Embedders Guide section on [Templates](https://github.com/v8/v8/wiki/Embedder%27s-Guide#templates) for further information.
4
-
5
- In order to expose functionality to JavaScript via a template, you must provide it to V8 in a form that it understands. Across the versions of V8 supported by NAN, JavaScript-accessible method signatures vary widely, NAN fully abstracts method declaration and provides you with an interface that is similar to the most recent V8 API but is backward-compatible with older versions that still use the now-deceased `v8::Argument` type.
6
-
7
- * **Method argument types**
8
- - <a href="#api_nan_function_callback_info"><b><code>Nan::FunctionCallbackInfo</code></b></a>
9
- - <a href="#api_nan_property_callback_info"><b><code>Nan::PropertyCallbackInfo</code></b></a>
10
- - <a href="#api_nan_return_value"><b><code>Nan::ReturnValue</code></b></a>
11
- * **Method declarations**
12
- - <a href="#api_nan_method"><b>Method declaration</b></a>
13
- - <a href="#api_nan_getter"><b>Getter declaration</b></a>
14
- - <a href="#api_nan_setter"><b>Setter declaration</b></a>
15
- - <a href="#api_nan_property_getter"><b>Property getter declaration</b></a>
16
- - <a href="#api_nan_property_setter"><b>Property setter declaration</b></a>
17
- - <a href="#api_nan_property_enumerator"><b>Property enumerator declaration</b></a>
18
- - <a href="#api_nan_property_deleter"><b>Property deleter declaration</b></a>
19
- - <a href="#api_nan_property_query"><b>Property query declaration</b></a>
20
- - <a href="#api_nan_index_getter"><b>Index getter declaration</b></a>
21
- - <a href="#api_nan_index_setter"><b>Index setter declaration</b></a>
22
- - <a href="#api_nan_index_enumerator"><b>Index enumerator declaration</b></a>
23
- - <a href="#api_nan_index_deleter"><b>Index deleter declaration</b></a>
24
- - <a href="#api_nan_index_query"><b>Index query declaration</b></a>
25
- * Method and template helpers
26
- - <a href="#api_nan_set_method"><b><code>Nan::SetMethod()</code></b></a>
27
- - <a href="#api_nan_set_prototype_method"><b><code>Nan::SetPrototypeMethod()</code></b></a>
28
- - <a href="#api_nan_set_accessor"><b><code>Nan::SetAccessor()</code></b></a>
29
- - <a href="#api_nan_set_named_property_handler"><b><code>Nan::SetNamedPropertyHandler()</code></b></a>
30
- - <a href="#api_nan_set_indexed_property_handler"><b><code>Nan::SetIndexedPropertyHandler()</code></b></a>
31
- - <a href="#api_nan_set_template"><b><code>Nan::SetTemplate()</code></b></a>
32
- - <a href="#api_nan_set_prototype_template"><b><code>Nan::SetPrototypeTemplate()</code></b></a>
33
- - <a href="#api_nan_set_instance_template"><b><code>Nan::SetInstanceTemplate()</code></b></a>
34
- - <a href="#api_nan_set_call_handler"><b><code>Nan::SetCallHandler()</code></b></a>
35
- - <a href="#api_nan_set_call_as_function_handler"><b><code>Nan::SetCallAsFunctionHandler()</code></b></a>
36
-
37
- <a name="api_nan_function_callback_info"></a>
38
- ### Nan::FunctionCallbackInfo
39
-
40
- `Nan::FunctionCallbackInfo` should be used in place of [`v8::FunctionCallbackInfo`](https://v8docs.nodesource.com/node-8.16/dd/d0d/classv8_1_1_function_callback_info.html), even with older versions of Node where `v8::FunctionCallbackInfo` does not exist.
41
-
42
- Definition:
43
-
44
- ```c++
45
- template<typename T> class FunctionCallbackInfo {
46
- public:
47
- ReturnValue<T> GetReturnValue() const;
48
- v8::Local<v8::Function> Callee(); // NOTE: Not available in NodeJS >= 10.0.0
49
- v8::Local<v8::Value> Data();
50
- v8::Local<v8::Object> Holder();
51
- bool IsConstructCall();
52
- int Length() const;
53
- v8::Local<v8::Value> operator[](int i) const;
54
- v8::Local<v8::Object> This() const;
55
- v8::Isolate *GetIsolate() const;
56
- };
57
- ```
58
-
59
- See the [`v8::FunctionCallbackInfo`](https://v8docs.nodesource.com/node-8.16/dd/d0d/classv8_1_1_function_callback_info.html) documentation for usage details on these. See [`Nan::ReturnValue`](#api_nan_return_value) for further information on how to set a return value from methods.
60
-
61
- **Note:** `FunctionCallbackInfo::Callee` is removed in Node.js after `10.0.0` because it is was deprecated in V8. Consider using `info.Data()` to pass any information you need.
62
-
63
- <a name="api_nan_property_callback_info"></a>
64
- ### Nan::PropertyCallbackInfo
65
-
66
- `Nan::PropertyCallbackInfo` should be used in place of [`v8::PropertyCallbackInfo`](https://v8docs.nodesource.com/node-8.16/d7/dc5/classv8_1_1_property_callback_info.html), even with older versions of Node where `v8::PropertyCallbackInfo` does not exist.
67
-
68
- Definition:
69
-
70
- ```c++
71
- template<typename T> class PropertyCallbackInfo : public PropertyCallbackInfoBase<T> {
72
- public:
73
- ReturnValue<T> GetReturnValue() const;
74
- v8::Isolate* GetIsolate() const;
75
- v8::Local<v8::Value> Data() const;
76
- v8::Local<v8::Object> This() const;
77
- v8::Local<v8::Object> Holder() const;
78
- };
79
- ```
80
-
81
- See the [`v8::PropertyCallbackInfo`](https://v8docs.nodesource.com/node-8.16/d7/dc5/classv8_1_1_property_callback_info.html) documentation for usage details on these. See [`Nan::ReturnValue`](#api_nan_return_value) for further information on how to set a return value from property accessor methods.
82
-
83
- <a name="api_nan_return_value"></a>
84
- ### Nan::ReturnValue
85
-
86
- `Nan::ReturnValue` is used in place of [`v8::ReturnValue`](https://v8docs.nodesource.com/node-8.16/da/da7/classv8_1_1_return_value.html) on both [`Nan::FunctionCallbackInfo`](#api_nan_function_callback_info) and [`Nan::PropertyCallbackInfo`](#api_nan_property_callback_info) as the return type of `GetReturnValue()`.
87
-
88
- Example usage:
89
-
90
- ```c++
91
- void EmptyArray(const Nan::FunctionCallbackInfo<v8::Value>& info) {
92
- info.GetReturnValue().Set(Nan::New<v8::Array>());
93
- }
94
- ```
95
-
96
- Definition:
97
-
98
- ```c++
99
- template<typename T> class ReturnValue {
100
- public:
101
- // Handle setters
102
- template <typename S> void Set(const v8::Local<S> &handle);
103
- template <typename S> void Set(const Nan::Global<S> &handle);
104
-
105
- // Fast primitive setters
106
- void Set(bool value);
107
- void Set(double i);
108
- void Set(int32_t i);
109
- void Set(uint32_t i);
110
-
111
- // Fast JS primitive setters
112
- void SetNull();
113
- void SetUndefined();
114
- void SetEmptyString();
115
-
116
- // Convenience getter for isolate
117
- v8::Isolate *GetIsolate() const;
118
- };
119
- ```
120
-
121
- See the documentation on [`v8::ReturnValue`](https://v8docs.nodesource.com/node-8.16/da/da7/classv8_1_1_return_value.html) for further information on this.
122
-
123
- <a name="api_nan_method"></a>
124
- ### Method declaration
125
-
126
- JavaScript-accessible methods should be declared with the following signature to form a `Nan::FunctionCallback`:
127
-
128
- ```c++
129
- typedef void(*FunctionCallback)(const FunctionCallbackInfo<v8::Value>&);
130
- ```
131
-
132
- Example:
133
-
134
- ```c++
135
- void MethodName(const Nan::FunctionCallbackInfo<v8::Value>& info) {
136
- ...
137
- }
138
- ```
139
-
140
- You do not need to declare a new `HandleScope` within a method as one is implicitly created for you.
141
-
142
- **Example usage**
143
-
144
- ```c++
145
- // .h:
146
- class Foo : public Nan::ObjectWrap {
147
- ...
148
-
149
- static void Bar(const Nan::FunctionCallbackInfo<v8::Value>& info);
150
- static void Baz(const Nan::FunctionCallbackInfo<v8::Value>& info);
151
- }
152
-
153
-
154
- // .cc:
155
- void Foo::Bar(const Nan::FunctionCallbackInfo<v8::Value>& info) {
156
- ...
157
- }
158
-
159
- void Foo::Baz(const Nan::FunctionCallbackInfo<v8::Value>& info) {
160
- ...
161
- }
162
- ```
163
-
164
- A helper macro `NAN_METHOD(methodname)` exists, compatible with NAN v1 method declarations.
165
-
166
- **Example usage with `NAN_METHOD(methodname)`**
167
-
168
- ```c++
169
- // .h:
170
- class Foo : public Nan::ObjectWrap {
171
- ...
172
-
173
- static NAN_METHOD(Bar);
174
- static NAN_METHOD(Baz);
175
- }
176
-
177
-
178
- // .cc:
179
- NAN_METHOD(Foo::Bar) {
180
- ...
181
- }
182
-
183
- NAN_METHOD(Foo::Baz) {
184
- ...
185
- }
186
- ```
187
-
188
- Use [`Nan::SetPrototypeMethod`](#api_nan_set_prototype_method) to attach a method to a JavaScript function prototype or [`Nan::SetMethod`](#api_nan_set_method) to attach a method directly on a JavaScript object.
189
-
190
- <a name="api_nan_getter"></a>
191
- ### Getter declaration
192
-
193
- JavaScript-accessible getters should be declared with the following signature to form a `Nan::GetterCallback`:
194
-
195
- ```c++
196
- typedef void(*GetterCallback)(v8::Local<v8::String>,
197
- const PropertyCallbackInfo<v8::Value>&);
198
- ```
199
-
200
- Example:
201
-
202
- ```c++
203
- void GetterName(v8::Local<v8::String> property,
204
- const Nan::PropertyCallbackInfo<v8::Value>& info) {
205
- ...
206
- }
207
- ```
208
-
209
- You do not need to declare a new `HandleScope` within a getter as one is implicitly created for you.
210
-
211
- A helper macro `NAN_GETTER(methodname)` exists, compatible with NAN v1 method declarations.
212
-
213
- Also see the V8 Embedders Guide documentation on [Accessors](https://developers.google.com/v8/embed#accesssors).
214
-
215
- <a name="api_nan_setter"></a>
216
- ### Setter declaration
217
-
218
- JavaScript-accessible setters should be declared with the following signature to form a <b><code>Nan::SetterCallback</code></b>:
219
-
220
- ```c++
221
- typedef void(*SetterCallback)(v8::Local<v8::String>,
222
- v8::Local<v8::Value>,
223
- const PropertyCallbackInfo<void>&);
224
- ```
225
-
226
- Example:
227
-
228
- ```c++
229
- void SetterName(v8::Local<v8::String> property,
230
- v8::Local<v8::Value> value,
231
- const Nan::PropertyCallbackInfo<void>& info) {
232
- ...
233
- }
234
- ```
235
-
236
- You do not need to declare a new `HandleScope` within a setter as one is implicitly created for you.
237
-
238
- A helper macro `NAN_SETTER(methodname)` exists, compatible with NAN v1 method declarations.
239
-
240
- Also see the V8 Embedders Guide documentation on [Accessors](https://developers.google.com/v8/embed#accesssors).
241
-
242
- <a name="api_nan_property_getter"></a>
243
- ### Property getter declaration
244
-
245
- JavaScript-accessible property getters should be declared with the following signature to form a <b><code>Nan::PropertyGetterCallback</code></b>:
246
-
247
- ```c++
248
- typedef void(*PropertyGetterCallback)(v8::Local<v8::String>,
249
- const PropertyCallbackInfo<v8::Value>&);
250
- ```
251
-
252
- Example:
253
-
254
- ```c++
255
- void PropertyGetterName(v8::Local<v8::String> property,
256
- const Nan::PropertyCallbackInfo<v8::Value>& info) {
257
- ...
258
- }
259
- ```
260
-
261
- You do not need to declare a new `HandleScope` within a property getter as one is implicitly created for you.
262
-
263
- A helper macro `NAN_PROPERTY_GETTER(methodname)` exists, compatible with NAN v1 method declarations.
264
-
265
- Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
266
-
267
- <a name="api_nan_property_setter"></a>
268
- ### Property setter declaration
269
-
270
- JavaScript-accessible property setters should be declared with the following signature to form a <b><code>Nan::PropertySetterCallback</code></b>:
271
-
272
- ```c++
273
- typedef void(*PropertySetterCallback)(v8::Local<v8::String>,
274
- v8::Local<v8::Value>,
275
- const PropertyCallbackInfo<v8::Value>&);
276
- ```
277
-
278
- Example:
279
-
280
- ```c++
281
- void PropertySetterName(v8::Local<v8::String> property,
282
- v8::Local<v8::Value> value,
283
- const Nan::PropertyCallbackInfo<v8::Value>& info);
284
- ```
285
-
286
- You do not need to declare a new `HandleScope` within a property setter as one is implicitly created for you.
287
-
288
- A helper macro `NAN_PROPERTY_SETTER(methodname)` exists, compatible with NAN v1 method declarations.
289
-
290
- Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
291
-
292
- <a name="api_nan_property_enumerator"></a>
293
- ### Property enumerator declaration
294
-
295
- JavaScript-accessible property enumerators should be declared with the following signature to form a <b><code>Nan::PropertyEnumeratorCallback</code></b>:
296
-
297
- ```c++
298
- typedef void(*PropertyEnumeratorCallback)(const PropertyCallbackInfo<v8::Array>&);
299
- ```
300
-
301
- Example:
302
-
303
- ```c++
304
- void PropertyEnumeratorName(const Nan::PropertyCallbackInfo<v8::Array>& info);
305
- ```
306
-
307
- You do not need to declare a new `HandleScope` within a property enumerator as one is implicitly created for you.
308
-
309
- A helper macro `NAN_PROPERTY_ENUMERATOR(methodname)` exists, compatible with NAN v1 method declarations.
310
-
311
- Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
312
-
313
- <a name="api_nan_property_deleter"></a>
314
- ### Property deleter declaration
315
-
316
- JavaScript-accessible property deleters should be declared with the following signature to form a <b><code>Nan::PropertyDeleterCallback</code></b>:
317
-
318
- ```c++
319
- typedef void(*PropertyDeleterCallback)(v8::Local<v8::String>,
320
- const PropertyCallbackInfo<v8::Boolean>&);
321
- ```
322
-
323
- Example:
324
-
325
- ```c++
326
- void PropertyDeleterName(v8::Local<v8::String> property,
327
- const Nan::PropertyCallbackInfo<v8::Boolean>& info);
328
- ```
329
-
330
- You do not need to declare a new `HandleScope` within a property deleter as one is implicitly created for you.
331
-
332
- A helper macro `NAN_PROPERTY_DELETER(methodname)` exists, compatible with NAN v1 method declarations.
333
-
334
- Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
335
-
336
- <a name="api_nan_property_query"></a>
337
- ### Property query declaration
338
-
339
- JavaScript-accessible property query methods should be declared with the following signature to form a <b><code>Nan::PropertyQueryCallback</code></b>:
340
-
341
- ```c++
342
- typedef void(*PropertyQueryCallback)(v8::Local<v8::String>,
343
- const PropertyCallbackInfo<v8::Integer>&);
344
- ```
345
-
346
- Example:
347
-
348
- ```c++
349
- void PropertyQueryName(v8::Local<v8::String> property,
350
- const Nan::PropertyCallbackInfo<v8::Integer>& info);
351
- ```
352
-
353
- You do not need to declare a new `HandleScope` within a property query method as one is implicitly created for you.
354
-
355
- A helper macro `NAN_PROPERTY_QUERY(methodname)` exists, compatible with NAN v1 method declarations.
356
-
357
- Also see the V8 Embedders Guide documentation on named property [Interceptors](https://developers.google.com/v8/embed#interceptors).
358
-
359
- <a name="api_nan_index_getter"></a>
360
- ### Index getter declaration
361
-
362
- JavaScript-accessible index getter methods should be declared with the following signature to form a <b><code>Nan::IndexGetterCallback</code></b>:
363
-
364
- ```c++
365
- typedef void(*IndexGetterCallback)(uint32_t,
366
- const PropertyCallbackInfo<v8::Value>&);
367
- ```
368
-
369
- Example:
370
-
371
- ```c++
372
- void IndexGetterName(uint32_t index, const PropertyCallbackInfo<v8::Value>& info);
373
- ```
374
-
375
- You do not need to declare a new `HandleScope` within a index getter as one is implicitly created for you.
376
-
377
- A helper macro `NAN_INDEX_GETTER(methodname)` exists, compatible with NAN v1 method declarations.
378
-
379
- Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
380
-
381
- <a name="api_nan_index_setter"></a>
382
- ### Index setter declaration
383
-
384
- JavaScript-accessible index setter methods should be declared with the following signature to form a <b><code>Nan::IndexSetterCallback</code></b>:
385
-
386
- ```c++
387
- typedef void(*IndexSetterCallback)(uint32_t,
388
- v8::Local<v8::Value>,
389
- const PropertyCallbackInfo<v8::Value>&);
390
- ```
391
-
392
- Example:
393
-
394
- ```c++
395
- void IndexSetterName(uint32_t index,
396
- v8::Local<v8::Value> value,
397
- const PropertyCallbackInfo<v8::Value>& info);
398
- ```
399
-
400
- You do not need to declare a new `HandleScope` within a index setter as one is implicitly created for you.
401
-
402
- A helper macro `NAN_INDEX_SETTER(methodname)` exists, compatible with NAN v1 method declarations.
403
-
404
- Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
405
-
406
- <a name="api_nan_index_enumerator"></a>
407
- ### Index enumerator declaration
408
-
409
- JavaScript-accessible index enumerator methods should be declared with the following signature to form a <b><code>Nan::IndexEnumeratorCallback</code></b>:
410
-
411
- ```c++
412
- typedef void(*IndexEnumeratorCallback)(const PropertyCallbackInfo<v8::Array>&);
413
- ```
414
-
415
- Example:
416
-
417
- ```c++
418
- void IndexEnumeratorName(const PropertyCallbackInfo<v8::Array>& info);
419
- ```
420
-
421
- You do not need to declare a new `HandleScope` within a index enumerator as one is implicitly created for you.
422
-
423
- A helper macro `NAN_INDEX_ENUMERATOR(methodname)` exists, compatible with NAN v1 method declarations.
424
-
425
- Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
426
-
427
- <a name="api_nan_index_deleter"></a>
428
- ### Index deleter declaration
429
-
430
- JavaScript-accessible index deleter methods should be declared with the following signature to form a <b><code>Nan::IndexDeleterCallback</code></b>:
431
-
432
- ```c++
433
- typedef void(*IndexDeleterCallback)(uint32_t,
434
- const PropertyCallbackInfo<v8::Boolean>&);
435
- ```
436
-
437
- Example:
438
-
439
- ```c++
440
- void IndexDeleterName(uint32_t index, const PropertyCallbackInfo<v8::Boolean>& info);
441
- ```
442
-
443
- You do not need to declare a new `HandleScope` within a index deleter as one is implicitly created for you.
444
-
445
- A helper macro `NAN_INDEX_DELETER(methodname)` exists, compatible with NAN v1 method declarations.
446
-
447
- Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
448
-
449
- <a name="api_nan_index_query"></a>
450
- ### Index query declaration
451
-
452
- JavaScript-accessible index query methods should be declared with the following signature to form a <b><code>Nan::IndexQueryCallback</code></b>:
453
-
454
- ```c++
455
- typedef void(*IndexQueryCallback)(uint32_t,
456
- const PropertyCallbackInfo<v8::Integer>&);
457
- ```
458
-
459
- Example:
460
-
461
- ```c++
462
- void IndexQueryName(uint32_t index, const PropertyCallbackInfo<v8::Integer>& info);
463
- ```
464
-
465
- You do not need to declare a new `HandleScope` within a index query method as one is implicitly created for you.
466
-
467
- A helper macro `NAN_INDEX_QUERY(methodname)` exists, compatible with NAN v1 method declarations.
468
-
469
- Also see the V8 Embedders Guide documentation on indexed property [Interceptors](https://developers.google.com/v8/embed#interceptors).
470
-
471
- <a name="api_nan_set_method"></a>
472
- ### Nan::SetMethod()
473
-
474
- Sets a method with a given name directly on a JavaScript object where the method has the `Nan::FunctionCallback` signature (see <a href="#api_nan_method">Method declaration</a>).
475
-
476
- Signature:
477
-
478
- ```c++
479
- void Nan::SetMethod(v8::Local<v8::Object> recv,
480
- const char *name,
481
- Nan::FunctionCallback callback,
482
- v8::Local<v8::Value> data = v8::Local<v8::Value>())
483
- void Nan::SetMethod(v8::Local<v8::Template> templ,
484
- const char *name,
485
- Nan::FunctionCallback callback,
486
- v8::Local<v8::Value> data = v8::Local<v8::Value>())
487
- ```
488
-
489
- <a name="api_nan_set_prototype_method"></a>
490
- ### Nan::SetPrototypeMethod()
491
-
492
- Sets a method with a given name on a `FunctionTemplate`'s prototype where the method has the `Nan::FunctionCallback` signature (see <a href="#api_nan_method">Method declaration</a>).
493
-
494
- Signature:
495
-
496
- ```c++
497
- void Nan::SetPrototypeMethod(v8::Local<v8::FunctionTemplate> recv,
498
- const char* name,
499
- Nan::FunctionCallback callback,
500
- v8::Local<v8::Value> data = v8::Local<v8::Value>())
501
- ```
502
-
503
- <a name="api_nan_set_accessor"></a>
504
- ### Nan::SetAccessor()
505
-
506
- Sets getters and setters for a property with a given name on an `ObjectTemplate` or a plain `Object`. Accepts getters with the `Nan::GetterCallback` signature (see <a href="#api_nan_getter">Getter declaration</a>) and setters with the `Nan::SetterCallback` signature (see <a href="#api_nan_setter">Setter declaration</a>).
507
-
508
- Signature:
509
-
510
- ```c++
511
- void SetAccessor(v8::Local<v8::ObjectTemplate> tpl,
512
- v8::Local<v8::String> name,
513
- Nan::GetterCallback getter,
514
- Nan::SetterCallback setter = 0,
515
- v8::Local<v8::Value> data = v8::Local<v8::Value>(),
516
- v8::AccessControl settings = v8::DEFAULT,
517
- v8::PropertyAttribute attribute = v8::None,
518
- imp::Sig signature = imp::Sig());
519
- bool SetAccessor(v8::Local<v8::Object> obj,
520
- v8::Local<v8::String> name,
521
- Nan::GetterCallback getter,
522
- Nan::SetterCallback setter = 0,
523
- v8::Local<v8::Value> data = v8::Local<v8::Value>(),
524
- v8::AccessControl settings = v8::DEFAULT,
525
- v8::PropertyAttribute attribute = v8::None)
526
- ```
527
-
528
- See the V8 [`ObjectTemplate#SetAccessor()`](https://v8docs.nodesource.com/node-8.16/db/d5f/classv8_1_1_object_template.html#aca0ed196f8a9adb1f68b1aadb6c9cd77) and [`Object#SetAccessor()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ae91b3b56b357f285288c89fbddc46d1b) for further information about how to use `Nan::SetAccessor()`.
529
-
530
- <a name="api_nan_set_named_property_handler"></a>
531
- ### Nan::SetNamedPropertyHandler()
532
-
533
- Sets named property getters, setters, query, deleter and enumerator methods on an `ObjectTemplate`. Accepts:
534
-
535
- * Property getters with the `Nan::PropertyGetterCallback` signature (see <a href="#api_nan_property_getter">Property getter declaration</a>)
536
- * Property setters with the `Nan::PropertySetterCallback` signature (see <a href="#api_nan_property_setter">Property setter declaration</a>)
537
- * Property query methods with the `Nan::PropertyQueryCallback` signature (see <a href="#api_nan_property_query">Property query declaration</a>)
538
- * Property deleters with the `Nan::PropertyDeleterCallback` signature (see <a href="#api_nan_property_deleter">Property deleter declaration</a>)
539
- * Property enumerators with the `Nan::PropertyEnumeratorCallback` signature (see <a href="#api_nan_property_enumerator">Property enumerator declaration</a>)
540
-
541
- Signature:
542
-
543
- ```c++
544
- void SetNamedPropertyHandler(v8::Local<v8::ObjectTemplate> tpl,
545
- Nan::PropertyGetterCallback getter,
546
- Nan::PropertySetterCallback setter = 0,
547
- Nan::PropertyQueryCallback query = 0,
548
- Nan::PropertyDeleterCallback deleter = 0,
549
- Nan::PropertyEnumeratorCallback enumerator = 0,
550
- v8::Local<v8::Value> data = v8::Local<v8::Value>())
551
- ```
552
-
553
- See the V8 [`ObjectTemplate#SetNamedPropertyHandler()`](https://v8docs.nodesource.com/node-8.16/db/d5f/classv8_1_1_object_template.html#a33b3ebd7de641f6cc6414b7de01fc1c7) for further information about how to use `Nan::SetNamedPropertyHandler()`.
554
-
555
- <a name="api_nan_set_indexed_property_handler"></a>
556
- ### Nan::SetIndexedPropertyHandler()
557
-
558
- Sets indexed property getters, setters, query, deleter and enumerator methods on an `ObjectTemplate`. Accepts:
559
-
560
- * Indexed property getters with the `Nan::IndexGetterCallback` signature (see <a href="#api_nan_index_getter">Index getter declaration</a>)
561
- * Indexed property setters with the `Nan::IndexSetterCallback` signature (see <a href="#api_nan_index_setter">Index setter declaration</a>)
562
- * Indexed property query methods with the `Nan::IndexQueryCallback` signature (see <a href="#api_nan_index_query">Index query declaration</a>)
563
- * Indexed property deleters with the `Nan::IndexDeleterCallback` signature (see <a href="#api_nan_index_deleter">Index deleter declaration</a>)
564
- * Indexed property enumerators with the `Nan::IndexEnumeratorCallback` signature (see <a href="#api_nan_index_enumerator">Index enumerator declaration</a>)
565
-
566
- Signature:
567
-
568
- ```c++
569
- void SetIndexedPropertyHandler(v8::Local<v8::ObjectTemplate> tpl,
570
- Nan::IndexGetterCallback getter,
571
- Nan::IndexSetterCallback setter = 0,
572
- Nan::IndexQueryCallback query = 0,
573
- Nan::IndexDeleterCallback deleter = 0,
574
- Nan::IndexEnumeratorCallback enumerator = 0,
575
- v8::Local<v8::Value> data = v8::Local<v8::Value>())
576
- ```
577
-
578
- See the V8 [`ObjectTemplate#SetIndexedPropertyHandler()`](https://v8docs.nodesource.com/node-8.16/db/d5f/classv8_1_1_object_template.html#ac89f06d634add0e890452033f7d17ff1) for further information about how to use `Nan::SetIndexedPropertyHandler()`.
579
-
580
- <a name="api_nan_set_template"></a>
581
- ### Nan::SetTemplate()
582
-
583
- Adds properties on an `Object`'s or `Function`'s template.
584
-
585
- Signature:
586
-
587
- ```c++
588
- void Nan::SetTemplate(v8::Local<v8::Template> templ,
589
- const char *name,
590
- v8::Local<v8::Data> value);
591
- void Nan::SetTemplate(v8::Local<v8::Template> templ,
592
- v8::Local<v8::String> name,
593
- v8::Local<v8::Data> value,
594
- v8::PropertyAttribute attributes)
595
- ```
596
-
597
- Calls the `Template`'s [`Set()`](https://v8docs.nodesource.com/node-8.16/db/df7/classv8_1_1_template.html#ae3fbaff137557aa6a0233bc7e52214ac).
598
-
599
- <a name="api_nan_set_prototype_template"></a>
600
- ### Nan::SetPrototypeTemplate()
601
-
602
- Adds properties on an `Object`'s or `Function`'s prototype template.
603
-
604
- Signature:
605
-
606
- ```c++
607
- void Nan::SetPrototypeTemplate(v8::Local<v8::FunctionTemplate> templ,
608
- const char *name,
609
- v8::Local<v8::Data> value);
610
- void Nan::SetPrototypeTemplate(v8::Local<v8::FunctionTemplate> templ,
611
- v8::Local<v8::String> name,
612
- v8::Local<v8::Data> value,
613
- v8::PropertyAttribute attributes)
614
- ```
615
-
616
- Calls the `FunctionTemplate`'s _PrototypeTemplate's_ [`Set()`](https://v8docs.nodesource.com/node-8.16/db/df7/classv8_1_1_template.html#a2db6a56597bf23c59659c0659e564ddf).
617
-
618
- <a name="api_nan_set_instance_template"></a>
619
- ### Nan::SetInstanceTemplate()
620
-
621
- Use to add instance properties on `FunctionTemplate`'s.
622
-
623
- Signature:
624
-
625
- ```c++
626
- void Nan::SetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ,
627
- const char *name,
628
- v8::Local<v8::Data> value);
629
- void Nan::SetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ,
630
- v8::Local<v8::String> name,
631
- v8::Local<v8::Data> value,
632
- v8::PropertyAttribute attributes)
633
- ```
634
-
635
- Calls the `FunctionTemplate`'s _InstanceTemplate's_ [`Set()`](https://v8docs.nodesource.com/node-8.16/db/df7/classv8_1_1_template.html#a2db6a56597bf23c59659c0659e564ddf).
636
-
637
- <a name="api_nan_set_call_handler"></a>
638
- ### Nan::SetCallHandler()
639
-
640
- Set the call-handler callback for a `v8::FunctionTemplate`.
641
- This callback is called whenever the function created from this FunctionTemplate is called.
642
-
643
- Signature:
644
-
645
- ```c++
646
- void Nan::SetCallHandler(v8::Local<v8::FunctionTemplate> templ, Nan::FunctionCallback callback, v8::Local<v8::Value> data = v8::Local<v8::Value>())
647
- ```
648
-
649
- Calls the `FunctionTemplate`'s [`SetCallHandler()`](https://v8docs.nodesource.com/node-8.16/d8/d83/classv8_1_1_function_template.html#ab7574b298db3c27fbc2ed465c08ea2f8).
650
-
651
- <a name="api_nan_set_call_as_function_handler"></a>
652
- ### Nan::SetCallAsFunctionHandler()
653
-
654
- Sets the callback to be used when calling instances created from the `v8::ObjectTemplate` as a function.
655
- If no callback is set, instances behave like normal JavaScript objects that cannot be called as a function.
656
-
657
- Signature:
658
-
659
- ```c++
660
- void Nan::SetCallAsFunctionHandler(v8::Local<v8::ObjectTemplate> templ, Nan::FunctionCallback callback, v8::Local<v8::Value> data = v8::Local<v8::Value>())
661
- ```
662
-
663
- Calls the `ObjectTemplate`'s [`SetCallAsFunctionHandler()`](https://v8docs.nodesource.com/node-8.16/db/d5f/classv8_1_1_object_template.html#a5e9612fc80bf6db8f2da199b9b0bd04e).
664
-