X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;f=node_modules%2Fwebsocket%2Fnode_modules%2Fnan%2Fdoc%2Fconverters.md;fp=node_modules%2Fwebsocket%2Fnode_modules%2Fnan%2Fdoc%2Fconverters.md;h=d20861b5935b6208b594b91f67cabd27a2bb5558;hb=0f4e331e6d75c244e978860b62a6e1aed8d446e0;hp=0000000000000000000000000000000000000000;hpb=0cb383f1c0646575a831f4f812cd85c9e24d9a18;p=VSoRC%2F.git
diff --git a/node_modules/websocket/node_modules/nan/doc/converters.md b/node_modules/websocket/node_modules/nan/doc/converters.md
new file mode 100644
index 0000000..d20861b
--- /dev/null
+++ b/node_modules/websocket/node_modules/nan/doc/converters.md
@@ -0,0 +1,41 @@
+## Converters
+
+NAN contains functions that convert `v8::Value`s to other `v8::Value` types and native types. Since type conversion is not guaranteed to succeed, they return `Nan::Maybe` types. These converters can be used in place of `value->ToX()` and `value->XValue()` (where `X` is one of the types, e.g. `Boolean`) in a way that provides a consistent interface across V8 versions. Newer versions of V8 use the new `v8::Maybe` and `v8::MaybeLocal` types for these conversions, older versions don't have this functionality so it is provided by NAN.
+
+ - Nan::To()
+
+
+### Nan::To()
+
+Converts a `v8::Local` to a different subtype of `v8::Value` or to a native data type. Returns a `Nan::MaybeLocal<>` or a `Nan::Maybe<>` accordingly.
+
+See [maybe_types.md](./maybe_types.md) for more information on `Nan::Maybe` types.
+
+Signatures:
+
+```c++
+// V8 types
+Nan::MaybeLocal Nan::To(v8::Local val);
+Nan::MaybeLocal Nan::To(v8::Local val);
+Nan::MaybeLocal Nan::To(v8::Local val);
+Nan::MaybeLocal Nan::To(v8::Local val);
+Nan::MaybeLocal Nan::To(v8::Local val);
+Nan::MaybeLocal Nan::To(v8::Local val);
+Nan::MaybeLocal Nan::To(v8::Local val);
+
+// Native types
+Nan::Maybe Nan::To(v8::Local val);
+Nan::Maybe Nan::To(v8::Local val);
+Nan::Maybe Nan::To(v8::Local val);
+Nan::Maybe Nan::To(v8::Local val);
+Nan::Maybe Nan::To(v8::Local val);
+```
+
+### Example
+
+```c++
+v8::Local val;
+Nan::MaybeLocal str = Nan::To(val);
+Nan::Maybe d = Nan::To(val);
+```
+