UNPKG

1.9 kBMarkdownView Raw
1## Strings & Bytes
2
3Miscellaneous 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
14An enum representing the supported encoding types. A copy of `node::encoding` that is consistent across versions of Node.
15
16Definition:
17
18```c++
19enum Nan::Encoding { ASCII, UTF8, BASE64, UCS2, BINARY, HEX, BUFFER }
20```
21
22
23<a name="api_nan_encode"></a>
24### Nan::Encode()
25
26A wrapper around `node::Encode()` that provides a consistent implementation across supported versions of Node.
27
28Signature:
29
30```c++
31v8::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
40A wrapper around `node::DecodeBytes()` that provides a consistent implementation across supported versions of Node.
41
42Signature:
43
44```c++
45ssize_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
53A wrapper around `node::DecodeWrite()` that provides a consistent implementation across supported versions of Node.
54
55Signature:
56
57```c++
58ssize_t Nan::DecodeWrite(char *buf,
59 size_t len,
60 v8::Local<v8::Value> val,
61 enum Nan::Encoding encoding = BINARY);
62```