@contrast/agent 4.3.1-0 → 4.5.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 (621) hide show
  1. package/LICENSE +10 -10
  2. package/README.md +86 -57
  3. package/agent-loader.js +14 -0
  4. package/bin/VERSION +1 -0
  5. package/bin/linux/contrast-service +0 -0
  6. package/bin/mac/contrast-service +0 -0
  7. package/bin/windows/contrast-service.exe +0 -0
  8. package/bootstrap.js +14 -0
  9. package/cli-rewriter.js +14 -0
  10. package/cli.js +14 -0
  11. package/esm.mjs +14 -0
  12. package/lib/agent-emitter.js +14 -0
  13. package/lib/agent.js +14 -0
  14. package/lib/app-info.js +14 -0
  15. package/lib/assess/deadzones/index.js +14 -0
  16. package/lib/assess/deadzones/rewrite.js +14 -0
  17. package/lib/assess/express/index.js +14 -0
  18. package/lib/assess/express/route-coverage.js +14 -0
  19. package/lib/assess/express/sinks/index.js +14 -0
  20. package/lib/assess/express/sinks/xss.js +14 -0
  21. package/lib/assess/express/sources.js +14 -0
  22. package/lib/assess/fastify/index.js +14 -0
  23. package/lib/assess/fastify/route-coverage.js +14 -0
  24. package/lib/assess/fastify/sinks/index.js +14 -0
  25. package/lib/assess/fastify/sinks/response-scanning.js +14 -0
  26. package/lib/assess/fastify/sinks/unvalidated-redirect.js +14 -0
  27. package/lib/assess/fastify/sinks/xss.js +14 -0
  28. package/lib/assess/fastify/sources.js +14 -0
  29. package/lib/assess/hapi/index.js +14 -0
  30. package/lib/assess/hapi/route-coverage.js +17 -3
  31. package/lib/assess/hapi/sinks/index.js +14 -0
  32. package/lib/assess/hapi/sinks/response-scanning.js +14 -0
  33. package/lib/assess/hapi/sinks/session.js +14 -0
  34. package/lib/assess/hapi/sinks/unvalidated-redirect.js +14 -0
  35. package/lib/assess/hapi/sinks/xss.js +14 -0
  36. package/lib/assess/hapi/sources.js +14 -0
  37. package/lib/assess/index.js +14 -0
  38. package/lib/assess/koa/index.js +14 -0
  39. package/lib/assess/koa/route-coverage.js +14 -0
  40. package/lib/assess/koa/sinks/index.js +14 -0
  41. package/lib/assess/koa/sinks/response-scanning.js +14 -0
  42. package/lib/assess/koa/sinks/unvalidated-redirect.js +14 -0
  43. package/lib/assess/koa/sinks/xss.js +14 -0
  44. package/lib/assess/koa/sources.js +14 -0
  45. package/lib/assess/loopback4/index.js +14 -0
  46. package/lib/assess/loopback4/route-coverage.js +14 -0
  47. package/lib/assess/loopback4/sinks/index.js +14 -0
  48. package/lib/assess/loopback4/sinks/response-scanning.js +14 -0
  49. package/lib/assess/loopback4/sinks/xss.js +14 -0
  50. package/lib/assess/loopback4/sources.js +14 -0
  51. package/lib/assess/membrane/debraner.js +14 -0
  52. package/lib/assess/membrane/deserialization-membrane.js +14 -0
  53. package/lib/assess/membrane/index.js +16 -8
  54. package/lib/assess/membrane/source-membrane.js +17 -4
  55. package/lib/assess/models/base-event.js +16 -2
  56. package/lib/assess/models/call-context.js +14 -3
  57. package/lib/assess/models/index.js +14 -0
  58. package/lib/assess/models/propagation-event.js +14 -0
  59. package/lib/assess/models/signature.js +14 -0
  60. package/lib/assess/models/sink-event.js +14 -0
  61. package/lib/assess/models/source-event.js +14 -0
  62. package/lib/assess/models/tag-range/index.js +20 -16
  63. package/lib/assess/models/tag-range/relationships.js +14 -0
  64. package/lib/assess/models/tag-range/util.js +14 -0
  65. package/lib/assess/policy/index.js +14 -0
  66. package/lib/assess/policy/init.js +14 -0
  67. package/lib/assess/policy/signatures.json +95 -0
  68. package/lib/assess/policy/util.js +23 -2
  69. package/lib/assess/propagators/JSON/parse.js +14 -0
  70. package/lib/assess/propagators/JSON/stringify.js +14 -0
  71. package/lib/assess/propagators/ajv/conditionals.js +14 -0
  72. package/lib/assess/propagators/ajv/evaluator-shim.js +14 -0
  73. package/lib/assess/propagators/ajv/index.js +14 -0
  74. package/lib/assess/propagators/ajv/json-schema-type-evaluators.js +14 -0
  75. package/lib/assess/propagators/ajv/object-walk.js +14 -0
  76. package/lib/assess/propagators/ajv/refs.js +14 -0
  77. package/lib/assess/propagators/ajv/schema-context.js +14 -0
  78. package/lib/assess/propagators/array-prototype-join.js +14 -0
  79. package/lib/assess/propagators/common.js +14 -0
  80. package/lib/assess/propagators/ejs-template-generate-source.js +14 -0
  81. package/lib/assess/propagators/handlebars-compile.js +14 -0
  82. package/lib/assess/propagators/handlebars-escape-expresssion.js +14 -0
  83. package/lib/assess/propagators/index.js +14 -0
  84. package/lib/assess/propagators/joi/boolean.js +14 -0
  85. package/lib/assess/propagators/joi/expression.js +14 -0
  86. package/lib/assess/propagators/joi/index.js +14 -0
  87. package/lib/assess/propagators/joi/number.js +14 -0
  88. package/lib/assess/propagators/joi/string-base.js +14 -0
  89. package/lib/assess/propagators/joi/string-schema.js +14 -0
  90. package/lib/assess/propagators/joi/values.js +14 -0
  91. package/lib/assess/propagators/manager.js +31 -3
  92. package/lib/assess/propagators/object.js +14 -0
  93. package/lib/assess/propagators/path/basename.js +14 -0
  94. package/lib/assess/propagators/path/common.js +47 -13
  95. package/lib/assess/propagators/path/dirname.js +14 -0
  96. package/lib/assess/propagators/path/extname.js +14 -0
  97. package/lib/assess/propagators/path/format.js +14 -0
  98. package/lib/assess/propagators/path/join.js +14 -0
  99. package/lib/assess/propagators/path/normalize.js +20 -1
  100. package/lib/assess/propagators/path/parse.js +14 -0
  101. package/lib/assess/propagators/path/relative.js +14 -0
  102. package/lib/assess/propagators/path/resolve.js +14 -0
  103. package/lib/assess/propagators/path/to-namespaced-path.js +14 -0
  104. package/lib/assess/propagators/pug-compile.js +14 -0
  105. package/lib/assess/propagators/querystring/escape.js +14 -0
  106. package/lib/assess/propagators/querystring/parse.js +14 -0
  107. package/lib/assess/propagators/querystring/stringify.js +14 -0
  108. package/lib/assess/propagators/querystring/unescape.js +14 -0
  109. package/lib/assess/propagators/querystring/utils.js +14 -0
  110. package/lib/assess/propagators/sequelize/sql-string-escape.js +14 -0
  111. package/lib/assess/propagators/sequelize/sql-string-format-named-parameters.js +14 -0
  112. package/lib/assess/propagators/sequelize/sql-string-format.js +14 -0
  113. package/lib/assess/propagators/sequelize/utils.js +14 -0
  114. package/lib/assess/propagators/string-prototype-replace.js +14 -0
  115. package/lib/assess/propagators/string-prototype-split.js +14 -0
  116. package/lib/assess/propagators/string-prototype-trim.js +14 -0
  117. package/lib/assess/propagators/string.js +14 -0
  118. package/lib/assess/propagators/templates.js +14 -0
  119. package/lib/assess/propagators/url/url-prototype-parse.js +14 -0
  120. package/lib/assess/propagators/url/url-url.js +14 -0
  121. package/lib/assess/propagators/url/utils.js +14 -0
  122. package/lib/assess/propagators/util/format.js +14 -0
  123. package/lib/assess/propagators/utils.js +14 -0
  124. package/lib/assess/propagators/v8/init-hooks.js +14 -0
  125. package/lib/assess/propagators/validator/init-hooks.js +14 -0
  126. package/lib/assess/propagators/validator/validator-methods.js +14 -0
  127. package/lib/assess/response-scanning/app-activity.js +14 -0
  128. package/lib/assess/response-scanning/autocomplete-missing.js +14 -2
  129. package/lib/assess/response-scanning/cache-controls-missing.js +14 -0
  130. package/lib/assess/response-scanning/clickjacking-control-missing.js +14 -0
  131. package/lib/assess/response-scanning/common.js +14 -0
  132. package/lib/assess/response-scanning/cookies/common.js +14 -0
  133. package/lib/assess/response-scanning/cookies/events.js +14 -0
  134. package/lib/assess/response-scanning/cookies/httponly.js +14 -0
  135. package/lib/assess/response-scanning/cookies/secure-flag-missing.js +14 -0
  136. package/lib/assess/response-scanning/headers/csp-header-insecure.js +14 -0
  137. package/lib/assess/response-scanning/headers/csp-header-missing.js +14 -0
  138. package/lib/assess/response-scanning/headers/csp-utils.js +14 -0
  139. package/lib/assess/response-scanning/headers/hsts-header-missing.js +14 -0
  140. package/lib/assess/response-scanning/headers/powered-by.js +14 -0
  141. package/lib/assess/response-scanning/headers/xcontenttype-header-missing.js +14 -0
  142. package/lib/assess/response-scanning/headers/xxssprotection-header-disabled.js +14 -0
  143. package/lib/assess/response-scanning/parameter-pollution.js +14 -2
  144. package/lib/assess/response-scanning/parseable-response-emitter.js +14 -0
  145. package/lib/assess/restify/index.js +14 -0
  146. package/lib/assess/restify/route-coverage.js +14 -0
  147. package/lib/assess/restify/session.js +14 -0
  148. package/lib/assess/restify/sinks/index.js +14 -0
  149. package/lib/assess/restify/sinks/response-scanning.js +14 -0
  150. package/lib/assess/restify/sinks/unvalidated-redirect.js +14 -0
  151. package/lib/assess/restify/sinks/xss.js +14 -0
  152. package/lib/assess/restify/sources.js +14 -0
  153. package/lib/assess/sinks/common.js +14 -0
  154. package/lib/assess/sinks/dynamo.js +14 -0
  155. package/lib/assess/sinks/hapi-16-xss.js +14 -0
  156. package/lib/assess/sinks/index.js +14 -0
  157. package/lib/assess/sinks/libxmljs-xxe.js +14 -0
  158. package/lib/assess/sinks/mongodb.js +25 -7
  159. package/lib/assess/sinks/ssrf-url.js +14 -0
  160. package/lib/assess/sources/formidable.js +14 -0
  161. package/lib/assess/sources/index.js +14 -0
  162. package/lib/assess/static/hardcoded.js +14 -0
  163. package/lib/assess/technologies/index.js +14 -0
  164. package/lib/assess/utils.js +14 -0
  165. package/lib/cli-rewriter/index.js +14 -0
  166. package/lib/constants.js +14 -0
  167. package/lib/contrast.js +18 -5
  168. package/lib/core/arch-components/dynamodb.js +14 -0
  169. package/lib/core/arch-components/index.js +14 -0
  170. package/lib/core/arch-components/mongodb.js +14 -0
  171. package/lib/core/arch-components/mysql.js +14 -0
  172. package/lib/core/arch-components/postgres.js +14 -0
  173. package/lib/core/arch-components/sqlite3.js +14 -0
  174. package/lib/core/async-storage/context.js +14 -0
  175. package/lib/core/async-storage/hooks/bluebird.js +34 -0
  176. package/lib/core/async-storage/hooks/mongodb-core.js +14 -0
  177. package/lib/core/async-storage/hooks/mysql.js +14 -0
  178. package/lib/core/async-storage/hooks/redis.js +14 -0
  179. package/lib/core/async-storage/hooks/utils.js +14 -0
  180. package/lib/core/async-storage/index.js +14 -0
  181. package/lib/core/async-storage/scopes/index.js +14 -0
  182. package/lib/core/common/formidable.js +14 -0
  183. package/lib/core/common/index.js +14 -0
  184. package/lib/core/config/options.js +14 -0
  185. package/lib/core/config/util.js +14 -0
  186. package/lib/core/exclusions/exclusion-factory.js +14 -0
  187. package/lib/core/exclusions/exclusion.js +14 -0
  188. package/lib/core/exclusions/input.js +14 -0
  189. package/lib/core/exclusions/url.js +14 -0
  190. package/lib/core/express/index.js +14 -0
  191. package/lib/core/express/utils.js +15 -1
  192. package/lib/core/fastify/index.js +14 -0
  193. package/lib/core/fastify/utils.js +14 -0
  194. package/lib/core/hapi/index.js +14 -0
  195. package/lib/core/hapi/utils.js +14 -0
  196. package/lib/core/index.js +14 -0
  197. package/lib/core/koa/index.js +14 -0
  198. package/lib/core/koa/utils.js +14 -0
  199. package/lib/core/logger/daily-rotate-file.js +14 -0
  200. package/lib/core/logger/dataflow-monitor.js +14 -0
  201. package/lib/core/logger/debug-logger.js +29 -17
  202. package/lib/core/logger/index.js +14 -0
  203. package/lib/core/logger/perf-logger.js +14 -0
  204. package/lib/core/logger/umbrella-logger.js +14 -0
  205. package/lib/core/loopback4/index.js +14 -0
  206. package/lib/core/metrics/index.js +14 -0
  207. package/lib/core/restify/index.js +14 -0
  208. package/lib/core/restify/utils.js +14 -0
  209. package/lib/core/rewrite/assignment-expression.js +14 -0
  210. package/lib/core/rewrite/binary-expression.js +14 -0
  211. package/lib/core/rewrite/call-expression.js +14 -0
  212. package/lib/core/rewrite/callees.js +14 -0
  213. package/lib/core/rewrite/catch-clause.js +14 -0
  214. package/lib/core/rewrite/function-wrap.js +14 -0
  215. package/lib/core/rewrite/index.js +14 -0
  216. package/lib/core/rewrite/injections.js +14 -0
  217. package/lib/core/rewrite/is-contrast-method.js +14 -0
  218. package/lib/core/rewrite/log.js +14 -0
  219. package/lib/core/rewrite/member-expression.js +14 -0
  220. package/lib/core/rewrite/object-property.js +14 -0
  221. package/lib/core/rewrite/prepend-globals.js +14 -0
  222. package/lib/core/rewrite/rewrite-log.js +14 -0
  223. package/lib/core/rewrite/switch-statement.js +14 -0
  224. package/lib/core/rewrite/template-literal.js +14 -0
  225. package/lib/core/stacktrace.js +15 -3
  226. package/lib/coverage.js +14 -0
  227. package/lib/feature-set.js +16 -1
  228. package/lib/generator-function.js +14 -0
  229. package/lib/hooks/array.js +14 -0
  230. package/lib/hooks/cluster.js +14 -0
  231. package/lib/hooks/dataflow-monitor.js +14 -0
  232. package/lib/hooks/encoding.js +15 -1
  233. package/lib/hooks/express-fileupload.js +14 -0
  234. package/lib/hooks/express-session.js +14 -0
  235. package/lib/hooks/fn-to-string.js +14 -0
  236. package/lib/hooks/frameworks/base.js +14 -0
  237. package/lib/hooks/frameworks/common.js +14 -0
  238. package/lib/hooks/frameworks/hapi16.js +14 -0
  239. package/lib/hooks/frameworks/http.js +14 -0
  240. package/lib/hooks/frameworks/https.js +14 -0
  241. package/lib/hooks/frameworks/index.js +14 -0
  242. package/lib/hooks/hapi-16-reply.js +14 -0
  243. package/lib/hooks/hapi-16-session.js +14 -0
  244. package/lib/hooks/http.js +14 -0
  245. package/lib/hooks/module/extensions.js +14 -0
  246. package/lib/hooks/module/helpers.js +14 -0
  247. package/lib/hooks/module/index.js +14 -0
  248. package/lib/hooks/newrelic.js +14 -0
  249. package/lib/hooks/object-is.js +14 -0
  250. package/lib/hooks/object-to-primitive.js +14 -0
  251. package/lib/hooks/patcher.js +28 -24
  252. package/lib/hooks/require.js +14 -0
  253. package/lib/hooks/stealthy-require.js +14 -0
  254. package/lib/instrumentation.js +14 -0
  255. package/lib/libraries.js +21 -3
  256. package/lib/library-usage.js +14 -0
  257. package/lib/list-installed.js +14 -0
  258. package/lib/protect/analysis/aho-corasick.js +27 -30
  259. package/lib/protect/analysis/dfsa-analyzer.js +14 -0
  260. package/lib/protect/errors/handler.js +14 -0
  261. package/lib/protect/errors/security-exception.js +14 -0
  262. package/lib/protect/express/index.js +14 -0
  263. package/lib/protect/express/sinks.js +14 -0
  264. package/lib/protect/express/sources.js +14 -0
  265. package/lib/protect/fastify/index.js +14 -0
  266. package/lib/protect/fastify/sinks.js +14 -0
  267. package/lib/protect/fastify/sources.js +14 -0
  268. package/lib/protect/hapi/error-handler.js +14 -0
  269. package/lib/protect/hapi/index.js +14 -0
  270. package/lib/protect/hapi/sinks.js +14 -0
  271. package/lib/protect/hapi/sources.js +14 -0
  272. package/lib/protect/index.js +14 -0
  273. package/lib/protect/input-analysis.js +14 -0
  274. package/lib/protect/koa/index.js +14 -0
  275. package/lib/protect/koa/sinks.js +14 -0
  276. package/lib/protect/koa/sources.js +14 -0
  277. package/lib/protect/listeners.js +14 -0
  278. package/lib/protect/loopback4/index.js +14 -0
  279. package/lib/protect/loopback4/sources.js +14 -0
  280. package/lib/protect/models/application-context.js +14 -0
  281. package/lib/protect/models/sink-event.js +14 -0
  282. package/lib/protect/models/source-event.js +14 -0
  283. package/lib/protect/restify/index.js +14 -0
  284. package/lib/protect/restify/sinks.js +14 -0
  285. package/lib/protect/restify/sources.js +14 -0
  286. package/lib/protect/rules/assessment.js +14 -0
  287. package/lib/protect/rules/attack-patterns.js +14 -0
  288. package/lib/protect/rules/base-scanner/index.js +14 -0
  289. package/lib/protect/rules/base-scanner/java-script-scanner.js +14 -0
  290. package/lib/protect/rules/base-scanner/postgresqlscanner.js +14 -0
  291. package/lib/protect/rules/base-scanner/scan-state.js +14 -0
  292. package/lib/protect/rules/base-scanner/substring-finder.js +14 -0
  293. package/lib/protect/rules/base-scanner/token-sequence.js +14 -0
  294. package/lib/protect/rules/bot-blocker/bot-blocker-rule.js +14 -0
  295. package/lib/protect/rules/bot-blocker/index.js +14 -0
  296. package/lib/protect/rules/cmd-injection/cmdinjection-rule.js +14 -0
  297. package/lib/protect/rules/cmd-injection-command-backdoors/backdoor-detector.js +17 -3
  298. package/lib/protect/rules/cmd-injection-command-backdoors/cmd-injection-command-backdoors-rule.js +14 -0
  299. package/lib/protect/rules/cmd-injection-semantic-chained-commands/chained-command-scanner.js +14 -0
  300. package/lib/protect/rules/cmd-injection-semantic-chained-commands/cmd-injection-semantic-chained-commands-rule.js +14 -0
  301. package/lib/protect/rules/cmd-injection-semantic-dangerous-paths/cmd-injection-semantic-dangerous-paths-rule.js +14 -0
  302. package/lib/protect/rules/cmd-injection-semantic-dangerous-paths/dangerous-paths-scanner.js +14 -0
  303. package/lib/protect/rules/common.js +14 -0
  304. package/lib/protect/rules/index.js +14 -0
  305. package/lib/protect/rules/ip-denylist/ip-denylist-rule.js +14 -0
  306. package/lib/protect/rules/method-tampering/evaluator.js +14 -0
  307. package/lib/protect/rules/method-tampering/method-tampering-rule.js +14 -0
  308. package/lib/protect/rules/nosqli/no-sql-injection-rule.js +14 -0
  309. package/lib/protect/rules/nosqli/nosql-scanner/index.js +14 -0
  310. package/lib/protect/rules/nosqli/nosql-scanner/mongodbscanner.js +14 -0
  311. package/lib/protect/rules/path-traversal/path-traversal-rule.js +14 -0
  312. package/lib/protect/rules/rule-factory.js +14 -0
  313. package/lib/protect/rules/signatures/cmd-injection/custom-searchers/chained-command-searcher.js +14 -0
  314. package/lib/protect/rules/signatures/cmd-injection/custom-searchers/index.js +14 -0
  315. package/lib/protect/rules/signatures/cmd-injection/index.js +14 -0
  316. package/lib/protect/rules/signatures/evaluator.js +14 -0
  317. package/lib/protect/rules/signatures/index.js +14 -0
  318. package/lib/protect/rules/signatures/nosql-injection/custom-searchers/index.js +14 -0
  319. package/lib/protect/rules/signatures/nosql-injection/custom-searchers/nosql-comment-searcher.js +14 -0
  320. package/lib/protect/rules/signatures/nosql-injection/custom-searchers/simple-or-searcher.js +14 -0
  321. package/lib/protect/rules/signatures/nosql-injection/index.js +14 -0
  322. package/lib/protect/rules/signatures/path-traversal/index.js +14 -0
  323. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/behavior-url-searcher.js +14 -0
  324. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/function-definition-searcher.js +14 -0
  325. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/immediate-function-searcher.js +14 -0
  326. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/index.js +14 -0
  327. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/link-and-src-target-searcher.js +14 -0
  328. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/location-set-searcher.js +14 -0
  329. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/map-access-searcher.js +14 -0
  330. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/native-function-execution-searcher.js +14 -0
  331. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/no-alnum-searcher.js +14 -0
  332. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/redefined-function-searcher.js +14 -0
  333. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/style-url-injection-searcher.js +14 -0
  334. package/lib/protect/rules/signatures/reflected-xss/custom-searchers/variable-assignment-searcher.js +14 -0
  335. package/lib/protect/rules/signatures/reflected-xss/helpers/function-call.js +15 -1
  336. package/lib/protect/rules/signatures/reflected-xss/index.js +14 -0
  337. package/lib/protect/rules/signatures/signature.js +14 -0
  338. package/lib/protect/rules/signatures/sql-injection/custom-searchers/if-else-drop-searcher.js +14 -0
  339. package/lib/protect/rules/signatures/sql-injection/custom-searchers/index.js +14 -0
  340. package/lib/protect/rules/signatures/sql-injection/custom-searchers/simple-or-searcher.js +14 -0
  341. package/lib/protect/rules/signatures/sql-injection/custom-searchers/sql-comment-searcher.js +14 -0
  342. package/lib/protect/rules/signatures/sql-injection/custom-searchers/time-function-searcher.js +14 -0
  343. package/lib/protect/rules/signatures/sql-injection/custom-searchers/tsql-exec-searcher.js +14 -0
  344. package/lib/protect/rules/signatures/sql-injection/index.js +14 -0
  345. package/lib/protect/rules/signatures/ssjs-injection/index.js +14 -0
  346. package/lib/protect/rules/signatures/unsafe-file-upload/index.js +14 -0
  347. package/lib/protect/rules/signatures/untrusted-deserialization/index.js +14 -0
  348. package/lib/protect/rules/sqli/generic-complicated.js +14 -0
  349. package/lib/protect/rules/sqli/sql-injection-rule.js +14 -0
  350. package/lib/protect/rules/sqli/sql-scanner/index.js +14 -0
  351. package/lib/protect/rules/sqli/sql-scanner/mysql-scanner.js +14 -0
  352. package/lib/protect/rules/ssjs-injection/evaluator.js +14 -0
  353. package/lib/protect/rules/ssjs-injection/ssjsinjection-rule.js +14 -0
  354. package/lib/protect/rules/unsafe-file-upload/unsafe-file-upload-rule.js +14 -0
  355. package/lib/protect/rules/untrusted-deserialization/untrusted-deserialization-rule.js +14 -0
  356. package/lib/protect/rules/virtual-patch/index.js +14 -0
  357. package/lib/protect/rules/virtual-patch/utils.js +14 -0
  358. package/lib/protect/rules/virtual-patch/virtual-patch-rule.js +14 -0
  359. package/lib/protect/rules/xss/helpers/function-call.js +15 -1
  360. package/lib/protect/rules/xss/reflected-xss-rule.js +14 -0
  361. package/lib/protect/rules/xxe/xxerule.js +14 -0
  362. package/lib/protect/sample-aggregator.js +14 -0
  363. package/lib/protect/samples.js +14 -0
  364. package/lib/protect/service.js +14 -0
  365. package/lib/protect/sinks/child-process.js +14 -0
  366. package/lib/protect/sinks/eval.js +14 -0
  367. package/lib/protect/sinks/fs.js +14 -0
  368. package/lib/protect/sinks/function.js +14 -0
  369. package/lib/protect/sinks/index.js +14 -0
  370. package/lib/protect/sinks/libxmljs.js +14 -0
  371. package/lib/protect/sinks/mongodb.js +14 -0
  372. package/lib/protect/sinks/mysql.js +14 -0
  373. package/lib/protect/sinks/node-serialize.js +14 -0
  374. package/lib/protect/sinks/postgres.js +14 -0
  375. package/lib/protect/sinks/sequelize.js +14 -0
  376. package/lib/protect/sinks/sqlite3.js +14 -0
  377. package/lib/protect/sinks/vm.js +14 -0
  378. package/lib/protect/sources/busboy.js +14 -0
  379. package/lib/protect/sources/formidable.js +14 -0
  380. package/lib/protect/sources/index.js +14 -0
  381. package/lib/protect/validators/authorization.js +14 -0
  382. package/lib/protect/validators/common.js +14 -0
  383. package/lib/protect/validators/connection.js +14 -0
  384. package/lib/protect/validators/content-length.js +14 -0
  385. package/lib/protect/validators/host.js +14 -0
  386. package/lib/protect/validators/if-none-match.js +14 -0
  387. package/lib/protect/validators/index.js +14 -0
  388. package/lib/protect/validators/origin.js +14 -0
  389. package/lib/reporter/app-activity-queue.js +14 -0
  390. package/lib/reporter/grpc-client.js +14 -0
  391. package/lib/reporter/messages/speedracer/activity.js +14 -0
  392. package/lib/reporter/messages/speedracer/application-create.js +14 -0
  393. package/lib/reporter/messages/speedracer/application-update.js +14 -0
  394. package/lib/reporter/messages/speedracer/base.js +14 -0
  395. package/lib/reporter/messages/speedracer/index.js +14 -0
  396. package/lib/reporter/messages/speedracer/observed-route.js +14 -0
  397. package/lib/reporter/messages/speedracer/poll.js +14 -0
  398. package/lib/reporter/messages/speedracer/request.js +14 -0
  399. package/lib/reporter/messages/speedracer/startup.js +14 -0
  400. package/lib/reporter/messaging-router.js +14 -0
  401. package/lib/reporter/models/app-activity/app-activity.js +14 -0
  402. package/lib/reporter/models/app-activity/attacker-activity.js +14 -0
  403. package/lib/reporter/models/app-activity/defend.js +14 -0
  404. package/lib/reporter/models/app-activity/inventory.js +14 -0
  405. package/lib/reporter/models/app-activity/protection-rule-activity.js +14 -0
  406. package/lib/reporter/models/app-activity/rule-events.js +14 -0
  407. package/lib/reporter/models/app-activity/sample.js +14 -0
  408. package/lib/reporter/models/app-activity/source.js +14 -0
  409. package/lib/reporter/models/app-activity/user-input.js +14 -0
  410. package/lib/reporter/models/app-create.js +14 -0
  411. package/lib/reporter/models/app-update/index.js +16 -4
  412. package/lib/reporter/models/app-update/library-manifest.js +14 -0
  413. package/lib/reporter/models/app-update/library-usage.js +14 -0
  414. package/lib/reporter/models/app-update/library.js +14 -0
  415. package/lib/reporter/models/event-tag.js +14 -0
  416. package/lib/reporter/models/finding/event.js +14 -0
  417. package/lib/reporter/models/finding/finding.js +14 -0
  418. package/lib/reporter/models/frameworks/express-request.js +14 -0
  419. package/lib/reporter/models/frameworks/fastify-request.js +14 -0
  420. package/lib/reporter/models/frameworks/hapi-request.js +14 -0
  421. package/lib/reporter/models/frameworks/index.js +14 -0
  422. package/lib/reporter/models/frameworks/koa-request.js +14 -0
  423. package/lib/reporter/models/frameworks/restify-request.js +14 -0
  424. package/lib/reporter/models/observed-route.js +14 -0
  425. package/lib/reporter/models/request.js +14 -0
  426. package/lib/reporter/models/route-coverage.js +14 -0
  427. package/lib/reporter/models/startup.js +14 -0
  428. package/lib/reporter/models/trace-event-source.js +14 -0
  429. package/lib/reporter/models/utils/request-factory.js +14 -0
  430. package/lib/reporter/models/utils/user-input-factory.js +14 -0
  431. package/lib/reporter/models/utils/user-input-kit.js +14 -0
  432. package/lib/reporter/mq-client.js +14 -0
  433. package/lib/reporter/server-activity-queue.js +14 -0
  434. package/lib/reporter/socket-client.js +14 -0
  435. package/lib/reporter/speedracer/base-connection-state.js +14 -0
  436. package/lib/reporter/speedracer/constants.js +14 -0
  437. package/lib/reporter/speedracer/failure-connection-state.js +14 -0
  438. package/lib/reporter/speedracer/index.js +14 -0
  439. package/lib/reporter/speedracer/success-connection-state.js +14 -0
  440. package/lib/reporter/speedracer/unknown-connection-state.js +14 -0
  441. package/lib/reporter/translations/enums.js +14 -0
  442. package/lib/reporter/translations/helpers.js +14 -0
  443. package/lib/reporter/translations/to-protobuf/dtm/activity.js +14 -0
  444. package/lib/reporter/translations/to-protobuf/dtm/address.js +14 -0
  445. package/lib/reporter/translations/to-protobuf/dtm/agent-startup.js +14 -0
  446. package/lib/reporter/translations/to-protobuf/dtm/application-create.js +14 -0
  447. package/lib/reporter/translations/to-protobuf/dtm/application-update.js +14 -0
  448. package/lib/reporter/translations/to-protobuf/dtm/architecture-component.js +14 -0
  449. package/lib/reporter/translations/to-protobuf/dtm/attack-result.js +14 -0
  450. package/lib/reporter/translations/to-protobuf/dtm/bot-blocker-details.js +14 -0
  451. package/lib/reporter/translations/to-protobuf/dtm/cmd-injection-details.js +14 -0
  452. package/lib/reporter/translations/to-protobuf/dtm/cmd-injection-semantic-analysis-details.js +14 -0
  453. package/lib/reporter/translations/to-protobuf/dtm/finding.js +14 -0
  454. package/lib/reporter/translations/to-protobuf/dtm/http-method-tampering-details.js +14 -0
  455. package/lib/reporter/translations/to-protobuf/dtm/http-request.js +14 -0
  456. package/lib/reporter/translations/to-protobuf/dtm/index.js +14 -0
  457. package/lib/reporter/translations/to-protobuf/dtm/ip-denylist-details.js +14 -0
  458. package/lib/reporter/translations/to-protobuf/dtm/library-usage-update.js +14 -0
  459. package/lib/reporter/translations/to-protobuf/dtm/no-sql-injection-details.js +14 -0
  460. package/lib/reporter/translations/to-protobuf/dtm/observed-route.js +14 -0
  461. package/lib/reporter/translations/to-protobuf/dtm/pair.js +14 -0
  462. package/lib/reporter/translations/to-protobuf/dtm/path-traversal-details.js +14 -0
  463. package/lib/reporter/translations/to-protobuf/dtm/poll.js +14 -0
  464. package/lib/reporter/translations/to-protobuf/dtm/rasp-rule-sample.js +14 -0
  465. package/lib/reporter/translations/to-protobuf/dtm/raw-request.js +14 -0
  466. package/lib/reporter/translations/to-protobuf/dtm/route-coverage.js +14 -0
  467. package/lib/reporter/translations/to-protobuf/dtm/simple-pair.js +14 -0
  468. package/lib/reporter/translations/to-protobuf/dtm/sql-injection-details.js +14 -0
  469. package/lib/reporter/translations/to-protobuf/dtm/ssjs-injection-details.js +14 -0
  470. package/lib/reporter/translations/to-protobuf/dtm/stack-trace-element.js +14 -0
  471. package/lib/reporter/translations/to-protobuf/dtm/trace-event/action.js +14 -0
  472. package/lib/reporter/translations/to-protobuf/dtm/trace-event/index.js +14 -0
  473. package/lib/reporter/translations/to-protobuf/dtm/trace-event/parent-object-id.js +14 -0
  474. package/lib/reporter/translations/to-protobuf/dtm/trace-event/trace-event-object.js +14 -0
  475. package/lib/reporter/translations/to-protobuf/dtm/trace-event/trace-event-signature.js +14 -0
  476. package/lib/reporter/translations/to-protobuf/dtm/trace-event/trace-event-source.js +14 -0
  477. package/lib/reporter/translations/to-protobuf/dtm/trace-event/trace-stack.js +14 -0
  478. package/lib/reporter/translations/to-protobuf/dtm/trace-event/trace-taint-range.js +14 -0
  479. package/lib/reporter/translations/to-protobuf/dtm/trace-event/type.js +14 -0
  480. package/lib/reporter/translations/to-protobuf/dtm/untrusted-deserialization-details.js +14 -0
  481. package/lib/reporter/translations/to-protobuf/dtm/user-input.js +14 -0
  482. package/lib/reporter/translations/to-protobuf/dtm/virtual-patch-details.js +14 -0
  483. package/lib/reporter/translations/to-protobuf/dtm/xss-details.js +14 -0
  484. package/lib/reporter/translations/to-protobuf/dtm/xxe-details.js +14 -0
  485. package/lib/reporter/translations/to-protobuf/index.js +14 -0
  486. package/lib/reporter/translations/to-protobuf/settings/application-settings.js +14 -0
  487. package/lib/reporter/translations/to-protobuf/settings/assess-features.js +14 -0
  488. package/lib/reporter/translations/to-protobuf/settings/auth.js +14 -0
  489. package/lib/reporter/translations/to-protobuf/settings/bot-blocker.js +14 -0
  490. package/lib/reporter/translations/to-protobuf/settings/custom-rule-feature.js +14 -0
  491. package/lib/reporter/translations/to-protobuf/settings/defend-features.js +14 -0
  492. package/lib/reporter/translations/to-protobuf/settings/exclusions.js +14 -0
  493. package/lib/reporter/translations/to-protobuf/settings/index.js +14 -0
  494. package/lib/reporter/translations/to-protobuf/settings/input-analysis-result.js +14 -0
  495. package/lib/reporter/translations/to-protobuf/settings/inventory-features.js +14 -0
  496. package/lib/reporter/translations/to-protobuf/settings/ip-filter.js +14 -0
  497. package/lib/reporter/translations/to-protobuf/settings/log-enhancer.js +14 -0
  498. package/lib/reporter/translations/to-protobuf/settings/protection-rule.js +14 -0
  499. package/lib/reporter/translations/to-protobuf/settings/reaction.js +14 -0
  500. package/lib/reporter/translations/to-protobuf/settings/rule-definition.js +14 -0
  501. package/lib/reporter/translations/to-protobuf/settings/sampling.js +14 -0
  502. package/lib/reporter/translations/to-protobuf/settings/server-features.js +14 -0
  503. package/lib/reporter/translations/to-protobuf/settings/syslog.js +14 -0
  504. package/lib/reporter/translations/to-protobuf/settings/virtual-patch.js +14 -0
  505. package/lib/reporter/ts-reporter.js +14 -0
  506. package/lib/tracker.js +14 -0
  507. package/lib/util/base64.js +14 -0
  508. package/lib/util/bitset.js +14 -0
  509. package/lib/util/block-request.js +14 -0
  510. package/lib/util/callback-resolver.js +14 -0
  511. package/lib/util/clean-stack.js +15 -1
  512. package/lib/util/clean-string/brackets.js +17 -3
  513. package/lib/util/clean-string/clean-string-base.js +14 -0
  514. package/lib/util/clean-string/comments.js +14 -0
  515. package/lib/util/clean-string/concatenations.js +15 -1
  516. package/lib/util/clean-string/jsclean-string.js +14 -0
  517. package/lib/util/clean-string/placeholders.js +14 -0
  518. package/lib/util/clean-string/util.js +15 -2
  519. package/lib/util/colors.js +14 -0
  520. package/lib/util/file-finder.js +14 -0
  521. package/lib/util/heap-dump.js +14 -0
  522. package/lib/util/html-util.js +14 -0
  523. package/lib/util/ip-analyzer.js +15 -1
  524. package/lib/util/is-agent-path.js +14 -0
  525. package/lib/util/is-contrast-error.js +14 -0
  526. package/lib/util/is-piped-to-dev.js +14 -0
  527. package/lib/util/is-string.js +14 -0
  528. package/lib/util/partial.js +14 -0
  529. package/lib/util/pkg-name.js +14 -0
  530. package/lib/util/request-util.js +14 -0
  531. package/lib/util/resolve-obj.js +14 -0
  532. package/lib/util/route-info.js +14 -0
  533. package/lib/util/source-map.js +14 -0
  534. package/lib/util/static-rules.js +14 -0
  535. package/lib/util/trace-util.js +14 -0
  536. package/lib/util/traverse.js +14 -0
  537. package/lib/util/user-input-evaluator.js +14 -0
  538. package/lib/util/xml-analyzer/external-entity-finder.js +15 -1
  539. package/node_modules/bindings/LICENSE.md +22 -0
  540. package/node_modules/bindings/README.md +98 -0
  541. package/node_modules/bindings/bindings.js +221 -0
  542. package/node_modules/bindings/package.json +32 -0
  543. package/node_modules/file-uri-to-path/.npmignore +1 -0
  544. package/node_modules/file-uri-to-path/.travis.yml +30 -0
  545. package/node_modules/file-uri-to-path/History.md +21 -0
  546. package/node_modules/file-uri-to-path/LICENSE +20 -0
  547. package/node_modules/file-uri-to-path/README.md +74 -0
  548. package/node_modules/file-uri-to-path/index.d.ts +2 -0
  549. package/node_modules/file-uri-to-path/index.js +66 -0
  550. package/node_modules/file-uri-to-path/package.json +36 -0
  551. package/node_modules/file-uri-to-path/test/test.js +24 -0
  552. package/node_modules/file-uri-to-path/test/tests.json +13 -0
  553. package/node_modules/nan/CHANGELOG.md +537 -0
  554. package/node_modules/nan/LICENSE.md +13 -0
  555. package/node_modules/nan/README.md +455 -0
  556. package/node_modules/nan/doc/asyncworker.md +146 -0
  557. package/node_modules/nan/doc/buffers.md +54 -0
  558. package/node_modules/nan/doc/callback.md +76 -0
  559. package/node_modules/nan/doc/converters.md +41 -0
  560. package/node_modules/nan/doc/errors.md +226 -0
  561. package/node_modules/nan/doc/json.md +62 -0
  562. package/node_modules/nan/doc/maybe_types.md +583 -0
  563. package/node_modules/nan/doc/methods.md +664 -0
  564. package/node_modules/nan/doc/new.md +147 -0
  565. package/node_modules/nan/doc/node_misc.md +123 -0
  566. package/node_modules/nan/doc/object_wrappers.md +263 -0
  567. package/node_modules/nan/doc/persistent.md +296 -0
  568. package/node_modules/nan/doc/scopes.md +73 -0
  569. package/node_modules/nan/doc/script.md +38 -0
  570. package/node_modules/nan/doc/string_bytes.md +62 -0
  571. package/node_modules/nan/doc/v8_internals.md +199 -0
  572. package/node_modules/nan/doc/v8_misc.md +85 -0
  573. package/node_modules/nan/include_dirs.js +1 -0
  574. package/node_modules/nan/nan.h +2898 -0
  575. package/node_modules/nan/nan_callbacks.h +88 -0
  576. package/node_modules/nan/nan_callbacks_12_inl.h +514 -0
  577. package/node_modules/nan/nan_callbacks_pre_12_inl.h +520 -0
  578. package/node_modules/nan/nan_converters.h +72 -0
  579. package/node_modules/nan/nan_converters_43_inl.h +68 -0
  580. package/node_modules/nan/nan_converters_pre_43_inl.h +42 -0
  581. package/node_modules/nan/nan_define_own_property_helper.h +29 -0
  582. package/node_modules/nan/nan_implementation_12_inl.h +430 -0
  583. package/node_modules/nan/nan_implementation_pre_12_inl.h +263 -0
  584. package/node_modules/nan/nan_json.h +166 -0
  585. package/node_modules/nan/nan_maybe_43_inl.h +356 -0
  586. package/node_modules/nan/nan_maybe_pre_43_inl.h +268 -0
  587. package/node_modules/nan/nan_new.h +340 -0
  588. package/node_modules/nan/nan_object_wrap.h +156 -0
  589. package/node_modules/nan/nan_persistent_12_inl.h +132 -0
  590. package/node_modules/nan/nan_persistent_pre_12_inl.h +242 -0
  591. package/node_modules/nan/nan_private.h +73 -0
  592. package/node_modules/nan/nan_string_bytes.h +305 -0
  593. package/node_modules/nan/nan_typedarray_contents.h +96 -0
  594. package/node_modules/nan/nan_weak.h +437 -0
  595. package/node_modules/nan/package.json +41 -0
  596. package/node_modules/nan/tools/1to2.js +412 -0
  597. package/node_modules/nan/tools/README.md +14 -0
  598. package/node_modules/nan/tools/package.json +19 -0
  599. package/node_modules/unix-dgram/LICENSE +13 -0
  600. package/node_modules/unix-dgram/README.md +107 -0
  601. package/node_modules/unix-dgram/binding.gyp +20 -0
  602. package/node_modules/unix-dgram/build/Makefile +324 -0
  603. package/node_modules/unix-dgram/build/Release/.deps/Release/obj.target/unix_dgram/src/unix_dgram.o.d +58 -0
  604. package/node_modules/unix-dgram/build/Release/.deps/Release/obj.target/unix_dgram.node.d +1 -0
  605. package/node_modules/unix-dgram/build/Release/.deps/Release/unix_dgram.node.d +1 -0
  606. package/node_modules/unix-dgram/build/Release/obj.target/unix_dgram/src/unix_dgram.o +0 -0
  607. package/node_modules/unix-dgram/build/Release/obj.target/unix_dgram.node +0 -0
  608. package/node_modules/unix-dgram/build/Release/unix_dgram.node +0 -0
  609. package/node_modules/unix-dgram/build/binding.Makefile +6 -0
  610. package/node_modules/unix-dgram/build/config.gypi +213 -0
  611. package/node_modules/unix-dgram/build/unix_dgram.target.mk +159 -0
  612. package/node_modules/unix-dgram/lib/unix_dgram.js +168 -0
  613. package/node_modules/unix-dgram/package.json +36 -0
  614. package/node_modules/unix-dgram/src/unix_dgram.cc +404 -0
  615. package/node_modules/unix-dgram/src/win_dummy.cc +7 -0
  616. package/node_modules/unix-dgram/test/test-connect-callback.js +68 -0
  617. package/node_modules/unix-dgram/test/test-connect.js +53 -0
  618. package/node_modules/unix-dgram/test/test-dgram-unix.js +58 -0
  619. package/node_modules/unix-dgram/test/test-send-error.js +26 -0
  620. package/package.json +3 -2
  621. package/perf-logs.js +14 -0
@@ -0,0 +1,296 @@
1
+ ## Persistent references
2
+
3
+ An object reference that is independent of any `HandleScope` is a _persistent_ reference. Where a `Local` handle only lives as long as the `HandleScope` in which it was allocated, a `Persistent` handle remains valid until it is explicitly disposed.
4
+
5
+ Due to the evolution of the V8 API, it is necessary for NAN to provide a wrapper implementation of the `Persistent` classes to supply compatibility across the V8 versions supported.
6
+
7
+ - <a href="#api_nan_persistent_base"><b><code>Nan::PersistentBase & v8::PersistentBase</code></b></a>
8
+ - <a href="#api_nan_non_copyable_persistent_traits"><b><code>Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits</code></b></a>
9
+ - <a href="#api_nan_copyable_persistent_traits"><b><code>Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits</code></b></a>
10
+ - <a href="#api_nan_persistent"><b><code>Nan::Persistent</code></b></a>
11
+ - <a href="#api_nan_global"><b><code>Nan::Global</code></b></a>
12
+ - <a href="#api_nan_weak_callback_info"><b><code>Nan::WeakCallbackInfo</code></b></a>
13
+ - <a href="#api_nan_weak_callback_type"><b><code>Nan::WeakCallbackType</code></b></a>
14
+
15
+ Also see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).
16
+
17
+ <a name="api_nan_persistent_base"></a>
18
+ ### Nan::PersistentBase & v8::PersistentBase
19
+
20
+ A persistent handle contains a reference to a storage cell in V8 which holds an object value and which is updated by the garbage collector whenever the object is moved. A new storage cell can be created using the constructor or `Nan::PersistentBase::Reset()`. Existing handles can be disposed using an argument-less `Nan::PersistentBase::Reset()`.
21
+
22
+ Definition:
23
+
24
+ _(note: this is implemented as `Nan::PersistentBase` for older versions of V8 and the native `v8::PersistentBase` is used for newer versions of V8)_
25
+
26
+ ```c++
27
+ template<typename T> class PersistentBase {
28
+ public:
29
+ /**
30
+ * If non-empty, destroy the underlying storage cell
31
+ */
32
+ void Reset();
33
+
34
+ /**
35
+ * If non-empty, destroy the underlying storage cell and create a new one with
36
+ * the contents of another if it is also non-empty
37
+ */
38
+ template<typename S> void Reset(const v8::Local<S> &other);
39
+
40
+ /**
41
+ * If non-empty, destroy the underlying storage cell and create a new one with
42
+ * the contents of another if it is also non-empty
43
+ */
44
+ template<typename S> void Reset(const PersistentBase<S> &other);
45
+
46
+ /** Returns true if the handle is empty. */
47
+ bool IsEmpty() const;
48
+
49
+ /**
50
+ * If non-empty, destroy the underlying storage cell
51
+ * IsEmpty() will return true after this call.
52
+ */
53
+ void Empty();
54
+
55
+ template<typename S> bool operator==(const PersistentBase<S> &that);
56
+
57
+ template<typename S> bool operator==(const v8::Local<S> &that);
58
+
59
+ template<typename S> bool operator!=(const PersistentBase<S> &that);
60
+
61
+ template<typename S> bool operator!=(const v8::Local<S> &that);
62
+
63
+ /**
64
+ * Install a finalization callback on this object.
65
+ * NOTE: There is no guarantee as to *when* or even *if* the callback is
66
+ * invoked. The invocation is performed solely on a best effort basis.
67
+ * As always, GC-based finalization should *not* be relied upon for any
68
+ * critical form of resource management! At the moment you can either
69
+ * specify a parameter for the callback or the location of two internal
70
+ * fields in the dying object.
71
+ */
72
+ template<typename P>
73
+ void SetWeak(P *parameter,
74
+ typename WeakCallbackInfo<P>::Callback callback,
75
+ WeakCallbackType type);
76
+
77
+ void ClearWeak();
78
+
79
+ /**
80
+ * Marks the reference to this object independent. Garbage collector is free
81
+ * to ignore any object groups containing this object. Weak callback for an
82
+ * independent handle should not assume that it will be preceded by a global
83
+ * GC prologue callback or followed by a global GC epilogue callback.
84
+ */
85
+ void MarkIndependent() const;
86
+
87
+ bool IsIndependent() const;
88
+
89
+ /** Checks if the handle holds the only reference to an object. */
90
+ bool IsNearDeath() const;
91
+
92
+ /** Returns true if the handle's reference is weak. */
93
+ bool IsWeak() const
94
+ };
95
+ ```
96
+
97
+ See the V8 documentation for [`PersistentBase`](https://v8docs.nodesource.com/node-8.16/d4/dca/classv8_1_1_persistent_base.html) for further information.
98
+
99
+ **Tip:** To get a `v8::Local` reference to the original object back from a `PersistentBase` or `Persistent` object:
100
+
101
+ ```c++
102
+ v8::Local<v8::Object> object = Nan::New(persistent);
103
+ ```
104
+
105
+ <a name="api_nan_non_copyable_persistent_traits"></a>
106
+ ### Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits
107
+
108
+ Default traits for `Nan::Persistent`. This class does not allow use of the a copy constructor or assignment operator. At present `kResetInDestructor` is not set, but that will change in a future version.
109
+
110
+ Definition:
111
+
112
+ _(note: this is implemented as `Nan::NonCopyablePersistentTraits` for older versions of V8 and the native `v8::NonCopyablePersistentTraits` is used for newer versions of V8)_
113
+
114
+ ```c++
115
+ template<typename T> class NonCopyablePersistentTraits {
116
+ public:
117
+ typedef Persistent<T, NonCopyablePersistentTraits<T> > NonCopyablePersistent;
118
+
119
+ static const bool kResetInDestructor = false;
120
+
121
+ template<typename S, typename M>
122
+ static void Copy(const Persistent<S, M> &source,
123
+ NonCopyablePersistent *dest);
124
+
125
+ template<typename O> static void Uncompilable();
126
+ };
127
+ ```
128
+
129
+ See the V8 documentation for [`NonCopyablePersistentTraits`](https://v8docs.nodesource.com/node-8.16/de/d73/classv8_1_1_non_copyable_persistent_traits.html) for further information.
130
+
131
+ <a name="api_nan_copyable_persistent_traits"></a>
132
+ ### Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits
133
+
134
+ A helper class of traits to allow copying and assignment of `Persistent`. This will clone the contents of storage cell, but not any of the flags, etc..
135
+
136
+ Definition:
137
+
138
+ _(note: this is implemented as `Nan::CopyablePersistentTraits` for older versions of V8 and the native `v8::NonCopyablePersistentTraits` is used for newer versions of V8)_
139
+
140
+ ```c++
141
+ template<typename T>
142
+ class CopyablePersistentTraits {
143
+ public:
144
+ typedef Persistent<T, CopyablePersistentTraits<T> > CopyablePersistent;
145
+
146
+ static const bool kResetInDestructor = true;
147
+
148
+ template<typename S, typename M>
149
+ static void Copy(const Persistent<S, M> &source,
150
+ CopyablePersistent *dest);
151
+ };
152
+ ```
153
+
154
+ See the V8 documentation for [`CopyablePersistentTraits`](https://v8docs.nodesource.com/node-8.16/da/d5c/structv8_1_1_copyable_persistent_traits.html) for further information.
155
+
156
+ <a name="api_nan_persistent"></a>
157
+ ### Nan::Persistent
158
+
159
+ A type of `PersistentBase` which allows copy and assignment. Copy, assignment and destructor behavior is controlled by the traits class `M`.
160
+
161
+ Definition:
162
+
163
+ ```c++
164
+ template<typename T, typename M = NonCopyablePersistentTraits<T> >
165
+ class Persistent;
166
+
167
+ template<typename T, typename M> class Persistent : public PersistentBase<T> {
168
+ public:
169
+ /**
170
+ * A Persistent with no storage cell.
171
+ */
172
+ Persistent();
173
+
174
+ /**
175
+ * Construct a Persistent from a v8::Local. When the v8::Local is non-empty, a
176
+ * new storage cell is created pointing to the same object, and no flags are
177
+ * set.
178
+ */
179
+ template<typename S> Persistent(v8::Local<S> that);
180
+
181
+ /**
182
+ * Construct a Persistent from a Persistent. When the Persistent is non-empty,
183
+ * a new storage cell is created pointing to the same object, and no flags are
184
+ * set.
185
+ */
186
+ Persistent(const Persistent &that);
187
+
188
+ /**
189
+ * The copy constructors and assignment operator create a Persistent exactly
190
+ * as the Persistent constructor, but the Copy function from the traits class
191
+ * is called, allowing the setting of flags based on the copied Persistent.
192
+ */
193
+ Persistent &operator=(const Persistent &that);
194
+
195
+ template <typename S, typename M2>
196
+ Persistent &operator=(const Persistent<S, M2> &that);
197
+
198
+ /**
199
+ * The destructor will dispose the Persistent based on the kResetInDestructor
200
+ * flags in the traits class. Since not calling dispose can result in a
201
+ * memory leak, it is recommended to always set this flag.
202
+ */
203
+ ~Persistent();
204
+ };
205
+ ```
206
+
207
+ See the V8 documentation for [`Persistent`](https://v8docs.nodesource.com/node-8.16/d2/d78/classv8_1_1_persistent.html) for further information.
208
+
209
+ <a name="api_nan_global"></a>
210
+ ### Nan::Global
211
+
212
+ A type of `PersistentBase` which has move semantics.
213
+
214
+ ```c++
215
+ template<typename T> class Global : public PersistentBase<T> {
216
+ public:
217
+ /**
218
+ * A Global with no storage cell.
219
+ */
220
+ Global();
221
+
222
+ /**
223
+ * Construct a Global from a v8::Local. When the v8::Local is non-empty, a new
224
+ * storage cell is created pointing to the same object, and no flags are set.
225
+ */
226
+ template<typename S> Global(v8::Local<S> that);
227
+ /**
228
+ * Construct a Global from a PersistentBase. When the Persistent is non-empty,
229
+ * a new storage cell is created pointing to the same object, and no flags are
230
+ * set.
231
+ */
232
+ template<typename S> Global(const PersistentBase<S> &that);
233
+
234
+ /**
235
+ * Pass allows returning globals from functions, etc.
236
+ */
237
+ Global Pass();
238
+ };
239
+ ```
240
+
241
+ See the V8 documentation for [`Global`](https://v8docs.nodesource.com/node-8.16/d5/d40/classv8_1_1_global.html) for further information.
242
+
243
+ <a name="api_nan_weak_callback_info"></a>
244
+ ### Nan::WeakCallbackInfo
245
+
246
+ `Nan::WeakCallbackInfo` is used as an argument when setting a persistent reference as weak. You may need to free any external resources attached to the object. It is a mirror of `v8:WeakCallbackInfo` as found in newer versions of V8.
247
+
248
+ Definition:
249
+
250
+ ```c++
251
+ template<typename T> class WeakCallbackInfo {
252
+ public:
253
+ typedef void (*Callback)(const WeakCallbackInfo<T>& data);
254
+
255
+ v8::Isolate *GetIsolate() const;
256
+
257
+ /**
258
+ * Get the parameter that was associated with the weak handle.
259
+ */
260
+ T *GetParameter() const;
261
+
262
+ /**
263
+ * Get pointer from internal field, index can be 0 or 1.
264
+ */
265
+ void *GetInternalField(int index) const;
266
+ };
267
+ ```
268
+
269
+ Example usage:
270
+
271
+ ```c++
272
+ void weakCallback(const WeakCallbackInfo<int> &data) {
273
+ int *parameter = data.GetParameter();
274
+ delete parameter;
275
+ }
276
+
277
+ Persistent<v8::Object> obj;
278
+ int *data = new int(0);
279
+ obj.SetWeak(data, callback, WeakCallbackType::kParameter);
280
+ ```
281
+
282
+ See the V8 documentation for [`WeakCallbackInfo`](https://v8docs.nodesource.com/node-8.16/d8/d06/classv8_1_1_weak_callback_info.html) for further information.
283
+
284
+ <a name="api_nan_weak_callback_type"></a>
285
+ ### Nan::WeakCallbackType
286
+
287
+ Represents the type of a weak callback.
288
+ A weak callback of type `kParameter` makes the supplied parameter to `Nan::PersistentBase::SetWeak` available through `WeakCallbackInfo::GetParameter`.
289
+ A weak callback of type `kInternalFields` uses up to two internal fields at indices 0 and 1 on the `Nan::PersistentBase<v8::Object>` being made weak.
290
+ Note that only `v8::Object`s and derivatives can have internal fields.
291
+
292
+ Definition:
293
+
294
+ ```c++
295
+ enum class WeakCallbackType { kParameter, kInternalFields };
296
+ ```
@@ -0,0 +1,73 @@
1
+ ## Scopes
2
+
3
+ A _local handle_ is a pointer to an object. All V8 objects are accessed using handles, they are necessary because of the way the V8 garbage collector works.
4
+
5
+ A handle scope can be thought of as a container for any number of handles. When you've finished with your handles, instead of deleting each one individually you can simply delete their scope.
6
+
7
+ The creation of `HandleScope` objects is different across the supported versions of V8. Therefore, NAN provides its own implementations that can be used safely across these.
8
+
9
+ - <a href="#api_nan_handle_scope"><b><code>Nan::HandleScope</code></b></a>
10
+ - <a href="#api_nan_escapable_handle_scope"><b><code>Nan::EscapableHandleScope</code></b></a>
11
+
12
+ Also see the V8 Embedders Guide section on [Handles and Garbage Collection](https://github.com/v8/v8/wiki/Embedder%27s%20Guide#handles-and-garbage-collection).
13
+
14
+ <a name="api_nan_handle_scope"></a>
15
+ ### Nan::HandleScope
16
+
17
+ A simple wrapper around [`v8::HandleScope`](https://v8docs.nodesource.com/node-8.16/d3/d95/classv8_1_1_handle_scope.html).
18
+
19
+ Definition:
20
+
21
+ ```c++
22
+ class Nan::HandleScope {
23
+ public:
24
+ Nan::HandleScope();
25
+ static int NumberOfHandles();
26
+ };
27
+ ```
28
+
29
+ Allocate a new `Nan::HandleScope` whenever you are creating new V8 JavaScript objects. Note that an implicit `HandleScope` is created for you on JavaScript-accessible methods so you do not need to insert one yourself.
30
+
31
+ Example:
32
+
33
+ ```c++
34
+ // new object is created, it needs a new scope:
35
+ void Pointless() {
36
+ Nan::HandleScope scope;
37
+ v8::Local<v8::Object> obj = Nan::New<v8::Object>();
38
+ }
39
+
40
+ // JavaScript-accessible method already has a HandleScope
41
+ NAN_METHOD(Pointless2) {
42
+ v8::Local<v8::Object> obj = Nan::New<v8::Object>();
43
+ }
44
+ ```
45
+
46
+ <a name="api_nan_escapable_handle_scope"></a>
47
+ ### Nan::EscapableHandleScope
48
+
49
+ Similar to [`Nan::HandleScope`](#api_nan_handle_scope) but should be used in cases where a function needs to return a V8 JavaScript type that has been created within it.
50
+
51
+ Definition:
52
+
53
+ ```c++
54
+ class Nan::EscapableHandleScope {
55
+ public:
56
+ Nan::EscapableHandleScope();
57
+ static int NumberOfHandles();
58
+ template<typename T> v8::Local<T> Escape(v8::Local<T> value);
59
+ }
60
+ ```
61
+
62
+ Use `Escape(value)` to return the object.
63
+
64
+ Example:
65
+
66
+ ```c++
67
+ v8::Local<v8::Object> EmptyObj() {
68
+ Nan::EscapableHandleScope scope;
69
+ v8::Local<v8::Object> obj = Nan::New<v8::Object>();
70
+ return scope.Escape(obj);
71
+ }
72
+ ```
73
+
@@ -0,0 +1,38 @@
1
+ ## Script
2
+
3
+ NAN provides a `v8::Script` helpers as the API has changed over the supported versions of V8.
4
+
5
+ - <a href="#api_nan_compile_script"><b><code>Nan::CompileScript()</code></b></a>
6
+ - <a href="#api_nan_run_script"><b><code>Nan::RunScript()</code></b></a>
7
+
8
+
9
+ <a name="api_nan_compile_script"></a>
10
+ ### Nan::CompileScript()
11
+
12
+ A wrapper around [`v8::ScriptCompiler::Compile()`](https://v8docs.nodesource.com/node-8.16/da/da5/classv8_1_1_script_compiler.html#a93f5072a0db55d881b969e9fc98e564b).
13
+
14
+ Note that `Nan::BoundScript` is an alias for `v8::Script`.
15
+
16
+ Signature:
17
+
18
+ ```c++
19
+ Nan::MaybeLocal<Nan::BoundScript> Nan::CompileScript(
20
+ v8::Local<v8::String> s,
21
+ const v8::ScriptOrigin& origin);
22
+ Nan::MaybeLocal<Nan::BoundScript> Nan::CompileScript(v8::Local<v8::String> s);
23
+ ```
24
+
25
+
26
+ <a name="api_nan_run_script"></a>
27
+ ### Nan::RunScript()
28
+
29
+ Calls `script->Run()` or `script->BindToCurrentContext()->Run(Nan::GetCurrentContext())`.
30
+
31
+ Note that `Nan::BoundScript` is an alias for `v8::Script` and `Nan::UnboundScript` is an alias for `v8::UnboundScript` where available and `v8::Script` on older versions of V8.
32
+
33
+ Signature:
34
+
35
+ ```c++
36
+ Nan::MaybeLocal<v8::Value> Nan::RunScript(v8::Local<Nan::UnboundScript> script)
37
+ Nan::MaybeLocal<v8::Value> Nan::RunScript(v8::Local<Nan::BoundScript> script)
38
+ ```
@@ -0,0 +1,62 @@
1
+ ## Strings & Bytes
2
+
3
+ Miscellaneous string & byte encoding and decoding functionality provided for compatibility across supported versions of V8 and Node. Implemented by NAN to ensure that all encoding types are supported, even for older versions of Node where they are missing.
4
+
5
+ - <a href="#api_nan_encoding"><b><code>Nan::Encoding</code></b></a>
6
+ - <a href="#api_nan_encode"><b><code>Nan::Encode()</code></b></a>
7
+ - <a href="#api_nan_decode_bytes"><b><code>Nan::DecodeBytes()</code></b></a>
8
+ - <a href="#api_nan_decode_write"><b><code>Nan::DecodeWrite()</code></b></a>
9
+
10
+
11
+ <a name="api_nan_encoding"></a>
12
+ ### Nan::Encoding
13
+
14
+ An enum representing the supported encoding types. A copy of `node::encoding` that is consistent across versions of Node.
15
+
16
+ Definition:
17
+
18
+ ```c++
19
+ enum Nan::Encoding { ASCII, UTF8, BASE64, UCS2, BINARY, HEX, BUFFER }
20
+ ```
21
+
22
+
23
+ <a name="api_nan_encode"></a>
24
+ ### Nan::Encode()
25
+
26
+ A wrapper around `node::Encode()` that provides a consistent implementation across supported versions of Node.
27
+
28
+ Signature:
29
+
30
+ ```c++
31
+ v8::Local<v8::Value> Nan::Encode(const void *buf,
32
+ size_t len,
33
+ enum Nan::Encoding encoding = BINARY);
34
+ ```
35
+
36
+
37
+ <a name="api_nan_decode_bytes"></a>
38
+ ### Nan::DecodeBytes()
39
+
40
+ A wrapper around `node::DecodeBytes()` that provides a consistent implementation across supported versions of Node.
41
+
42
+ Signature:
43
+
44
+ ```c++
45
+ ssize_t Nan::DecodeBytes(v8::Local<v8::Value> val,
46
+ enum Nan::Encoding encoding = BINARY);
47
+ ```
48
+
49
+
50
+ <a name="api_nan_decode_write"></a>
51
+ ### Nan::DecodeWrite()
52
+
53
+ A wrapper around `node::DecodeWrite()` that provides a consistent implementation across supported versions of Node.
54
+
55
+ Signature:
56
+
57
+ ```c++
58
+ ssize_t Nan::DecodeWrite(char *buf,
59
+ size_t len,
60
+ v8::Local<v8::Value> val,
61
+ enum Nan::Encoding encoding = BINARY);
62
+ ```
@@ -0,0 +1,199 @@
1
+ ## V8 internals
2
+
3
+ The hooks to access V8 internals—including GC and statistics—are different across the supported versions of V8, therefore NAN provides its own hooks that call the appropriate V8 methods.
4
+
5
+ - <a href="#api_nan_gc_callback"><b><code>NAN_GC_CALLBACK()</code></b></a>
6
+ - <a href="#api_nan_add_gc_epilogue_callback"><b><code>Nan::AddGCEpilogueCallback()</code></b></a>
7
+ - <a href="#api_nan_remove_gc_epilogue_callback"><b><code>Nan::RemoveGCEpilogueCallback()</code></b></a>
8
+ - <a href="#api_nan_add_gc_prologue_callback"><b><code>Nan::AddGCPrologueCallback()</code></b></a>
9
+ - <a href="#api_nan_remove_gc_prologue_callback"><b><code>Nan::RemoveGCPrologueCallback()</code></b></a>
10
+ - <a href="#api_nan_get_heap_statistics"><b><code>Nan::GetHeapStatistics()</code></b></a>
11
+ - <a href="#api_nan_set_counter_function"><b><code>Nan::SetCounterFunction()</code></b></a>
12
+ - <a href="#api_nan_set_create_histogram_function"><b><code>Nan::SetCreateHistogramFunction()</code></b></a>
13
+ - <a href="#api_nan_set_add_histogram_sample_function"><b><code>Nan::SetAddHistogramSampleFunction()</code></b></a>
14
+ - <a href="#api_nan_idle_notification"><b><code>Nan::IdleNotification()</code></b></a>
15
+ - <a href="#api_nan_low_memory_notification"><b><code>Nan::LowMemoryNotification()</code></b></a>
16
+ - <a href="#api_nan_context_disposed_notification"><b><code>Nan::ContextDisposedNotification()</code></b></a>
17
+ - <a href="#api_nan_get_internal_field_pointer"><b><code>Nan::GetInternalFieldPointer()</code></b></a>
18
+ - <a href="#api_nan_set_internal_field_pointer"><b><code>Nan::SetInternalFieldPointer()</code></b></a>
19
+ - <a href="#api_nan_adjust_external_memory"><b><code>Nan::AdjustExternalMemory()</code></b></a>
20
+
21
+
22
+ <a name="api_nan_gc_callback"></a>
23
+ ### NAN_GC_CALLBACK(callbackname)
24
+
25
+ Use `NAN_GC_CALLBACK` to declare your callbacks for `Nan::AddGCPrologueCallback()` and `Nan::AddGCEpilogueCallback()`. Your new method receives the arguments `v8::GCType type` and `v8::GCCallbackFlags flags`.
26
+
27
+ ```c++
28
+ static Nan::Persistent<Function> callback;
29
+
30
+ NAN_GC_CALLBACK(gcPrologueCallback) {
31
+ v8::Local<Value> argv[] = { Nan::New("prologue").ToLocalChecked() };
32
+ Nan::MakeCallback(Nan::GetCurrentContext()->Global(), Nan::New(callback), 1, argv);
33
+ }
34
+
35
+ NAN_METHOD(Hook) {
36
+ callback.Reset(To<Function>(args[0]).ToLocalChecked());
37
+ Nan::AddGCPrologueCallback(gcPrologueCallback);
38
+ info.GetReturnValue().Set(info.Holder());
39
+ }
40
+ ```
41
+
42
+ <a name="api_nan_add_gc_epilogue_callback"></a>
43
+ ### Nan::AddGCEpilogueCallback()
44
+
45
+ Signature:
46
+
47
+ ```c++
48
+ void Nan::AddGCEpilogueCallback(v8::Isolate::GCEpilogueCallback callback, v8::GCType gc_type_filter = v8::kGCTypeAll)
49
+ ```
50
+
51
+ Calls V8's [`AddGCEpilogueCallback()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#a580f976e4290cead62c2fc4dd396be3e).
52
+
53
+ <a name="api_nan_remove_gc_epilogue_callback"></a>
54
+ ### Nan::RemoveGCEpilogueCallback()
55
+
56
+ Signature:
57
+
58
+ ```c++
59
+ void Nan::RemoveGCEpilogueCallback(v8::Isolate::GCEpilogueCallback callback)
60
+ ```
61
+
62
+ Calls V8's [`RemoveGCEpilogueCallback()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#adca9294555a3908e9f23c7bb0f0f284c).
63
+
64
+ <a name="api_nan_add_gc_prologue_callback"></a>
65
+ ### Nan::AddGCPrologueCallback()
66
+
67
+ Signature:
68
+
69
+ ```c++
70
+ void Nan::AddGCPrologueCallback(v8::Isolate::GCPrologueCallback, v8::GCType gc_type_filter callback)
71
+ ```
72
+
73
+ Calls V8's [`AddGCPrologueCallback()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#a6dbef303603ebdb03da6998794ea05b8).
74
+
75
+ <a name="api_nan_remove_gc_prologue_callback"></a>
76
+ ### Nan::RemoveGCPrologueCallback()
77
+
78
+ Signature:
79
+
80
+ ```c++
81
+ void Nan::RemoveGCPrologueCallback(v8::Isolate::GCPrologueCallback callback)
82
+ ```
83
+
84
+ Calls V8's [`RemoveGCPrologueCallback()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#a5f72c7cda21415ce062bbe5c58abe09e).
85
+
86
+ <a name="api_nan_get_heap_statistics"></a>
87
+ ### Nan::GetHeapStatistics()
88
+
89
+ Signature:
90
+
91
+ ```c++
92
+ void Nan::GetHeapStatistics(v8::HeapStatistics *heap_statistics)
93
+ ```
94
+
95
+ Calls V8's [`GetHeapStatistics()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#a5593ac74687b713095c38987e5950b34).
96
+
97
+ <a name="api_nan_set_counter_function"></a>
98
+ ### Nan::SetCounterFunction()
99
+
100
+ Signature:
101
+
102
+ ```c++
103
+ void Nan::SetCounterFunction(v8::CounterLookupCallback cb)
104
+ ```
105
+
106
+ Calls V8's [`SetCounterFunction()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#a045d7754e62fa0ec72ae6c259b29af94).
107
+
108
+ <a name="api_nan_set_create_histogram_function"></a>
109
+ ### Nan::SetCreateHistogramFunction()
110
+
111
+ Signature:
112
+
113
+ ```c++
114
+ void Nan::SetCreateHistogramFunction(v8::CreateHistogramCallback cb)
115
+ ```
116
+
117
+ Calls V8's [`SetCreateHistogramFunction()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#a542d67e85089cb3f92aadf032f99e732).
118
+
119
+ <a name="api_nan_set_add_histogram_sample_function"></a>
120
+ ### Nan::SetAddHistogramSampleFunction()
121
+
122
+ Signature:
123
+
124
+ ```c++
125
+ void Nan::SetAddHistogramSampleFunction(v8::AddHistogramSampleCallback cb)
126
+ ```
127
+
128
+ Calls V8's [`SetAddHistogramSampleFunction()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#aeb420b690bc2c216882d6fdd00ddd3ea).
129
+
130
+ <a name="api_nan_idle_notification"></a>
131
+ ### Nan::IdleNotification()
132
+
133
+ Signature:
134
+
135
+ ```c++
136
+ bool Nan::IdleNotification(int idle_time_in_ms)
137
+ ```
138
+
139
+ Calls V8's [`IdleNotification()` or `IdleNotificationDeadline()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#ad6a2a02657f5425ad460060652a5a118) depending on V8 version.
140
+
141
+ <a name="api_nan_low_memory_notification"></a>
142
+ ### Nan::LowMemoryNotification()
143
+
144
+ Signature:
145
+
146
+ ```c++
147
+ void Nan::LowMemoryNotification()
148
+ ```
149
+
150
+ Calls V8's [`LowMemoryNotification()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#a24647f61d6b41f69668094bdcd6ea91f).
151
+
152
+ <a name="api_nan_context_disposed_notification"></a>
153
+ ### Nan::ContextDisposedNotification()
154
+
155
+ Signature:
156
+
157
+ ```c++
158
+ void Nan::ContextDisposedNotification()
159
+ ```
160
+
161
+ Calls V8's [`ContextDisposedNotification()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#ad7f5dc559866343fe6cd8db1f134d48b).
162
+
163
+ <a name="api_nan_get_internal_field_pointer"></a>
164
+ ### Nan::GetInternalFieldPointer()
165
+
166
+ Gets a pointer to the internal field with at `index` from a V8 `Object` handle.
167
+
168
+ Signature:
169
+
170
+ ```c++
171
+ void* Nan::GetInternalFieldPointer(v8::Local<v8::Object> object, int index)
172
+ ```
173
+
174
+ Calls the Object's [`GetAlignedPointerFromInternalField()` or `GetPointerFromInternalField()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a580ea84afb26c005d6762eeb9e3c308f) depending on the version of V8.
175
+
176
+ <a name="api_nan_set_internal_field_pointer"></a>
177
+ ### Nan::SetInternalFieldPointer()
178
+
179
+ Sets the value of the internal field at `index` on a V8 `Object` handle.
180
+
181
+ Signature:
182
+
183
+ ```c++
184
+ void Nan::SetInternalFieldPointer(v8::Local<v8::Object> object, int index, void* value)
185
+ ```
186
+
187
+ Calls the Object's [`SetAlignedPointerInInternalField()` or `SetPointerInInternalField()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ab3c57184263cf29963ef0017bec82281) depending on the version of V8.
188
+
189
+ <a name="api_nan_adjust_external_memory"></a>
190
+ ### Nan::AdjustExternalMemory()
191
+
192
+ Signature:
193
+
194
+ ```c++
195
+ int Nan::AdjustExternalMemory(int bytesChange)
196
+ ```
197
+
198
+ Calls V8's [`AdjustAmountOfExternalAllocatedMemory()`](https://v8docs.nodesource.com/node-8.16/d5/dda/classv8_1_1_isolate.html#ae1a59cac60409d3922582c4af675473e).
199
+