From a5c417748112e9d88d9ca522561e338eb9ba9007 Mon Sep 17 00:00:00 2001
From: Minteck <contact@minteck.org>
Date: Fri, 25 Feb 2022 18:08:27 +0100
Subject: Initial commit

---
 node_modules/nan/doc/script.md | 58 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 node_modules/nan/doc/script.md

(limited to 'node_modules/nan/doc/script.md')

diff --git a/node_modules/nan/doc/script.md b/node_modules/nan/doc/script.md
new file mode 100644
index 0000000..301c1b3
--- /dev/null
+++ b/node_modules/nan/doc/script.md
@@ -0,0 +1,58 @@
+## Script
+
+NAN provides `v8::Script` helpers as the API has changed over the supported versions of V8.
+
+ - <a href="#api_nan_compile_script"><b><code>Nan::CompileScript()</code></b></a>
+ - <a href="#api_nan_run_script"><b><code>Nan::RunScript()</code></b></a>
+ - <a href="#api_nan_script_origin"><b><code>Nan::ScriptOrigin</code></b></a>
+
+
+<a name="api_nan_compile_script"></a>
+### Nan::CompileScript()
+
+A wrapper around [`v8::ScriptCompiler::Compile()`](https://v8docs.nodesource.com/node-8.16/da/da5/classv8_1_1_script_compiler.html#a93f5072a0db55d881b969e9fc98e564b).
+
+Note that `Nan::BoundScript` is an alias for `v8::Script`.
+
+Signature:
+
+```c++
+Nan::MaybeLocal<Nan::BoundScript> Nan::CompileScript(
+    v8::Local<v8::String> s,
+    const v8::ScriptOrigin& origin);
+Nan::MaybeLocal<Nan::BoundScript> Nan::CompileScript(v8::Local<v8::String> s);
+```
+
+
+<a name="api_nan_run_script"></a>
+### Nan::RunScript()
+
+Calls `script->Run()` or `script->BindToCurrentContext()->Run(Nan::GetCurrentContext())`.
+
+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.
+
+Signature:
+
+```c++
+Nan::MaybeLocal<v8::Value> Nan::RunScript(v8::Local<Nan::UnboundScript> script)
+Nan::MaybeLocal<v8::Value> Nan::RunScript(v8::Local<Nan::BoundScript> script)
+```
+
+<a name="api_nan_script_origin"></a>
+### Nan::ScriptOrigin
+
+A class transparently extending [`v8::ScriptOrigin`](https://v8docs.nodesource.com/node-16.0/db/d84/classv8_1_1_script_origin.html#pub-methods)
+to provide backwards compatibility. Only the listed methods are guaranteed to
+be available on all versions of Node.
+
+Declaration:
+
+```c++
+class Nan::ScriptOrigin : public v8::ScriptOrigin {
+ public:
+  ScriptOrigin(v8::Local<v8::Value> name, v8::Local<v8::Integer> line = v8::Local<v8::Integer>(), v8::Local<v8::Integer> column = v8::Local<v8::Integer>())
+  v8::Local<v8::Value> ResourceName() const;
+  v8::Local<v8::Integer> ResourceLineOffset() const;
+  v8::Local<v8::Integer> ResourceColumnOffset() const;
+}
+```
-- 
cgit