[ini]
Christian Fraß

Christian Fraß commited on 2021-11-18 23:53:54
Zeige 94 geänderte Dateien mit 20408 Einfügungen und 0 Löschungen.

... ...
@@ -0,0 +1,2 @@
1
+temp/
2
+build/
... ...
@@ -0,0 +1,36 @@
1
+{
2
+  "name": "node",
3
+  "lockfileVersion": 2,
4
+  "requires": true,
5
+  "packages": {
6
+    "node_modules/irc": {
7
+      "version": "0.5.2",
8
+      "resolved": "https://registry.npmjs.org/irc/-/irc-0.5.2.tgz",
9
+      "integrity": "sha1-NxT0doNlqW0LL3dryRFmvrJGS7w=",
10
+      "dependencies": {
11
+        "irc-colors": "^1.1.0"
12
+      },
13
+      "engines": {
14
+        "node": ">=0.10.0"
15
+      },
16
+      "optionalDependencies": {
17
+        "iconv": "~2.2.1",
18
+        "node-icu-charset-detector": "~0.2.0"
19
+      }
20
+    },
21
+    "node_modules/irc-colors": {
22
+      "version": "1.5.0",
23
+      "resolved": "https://registry.npmjs.org/irc-colors/-/irc-colors-1.5.0.tgz",
24
+      "integrity": "sha512-HtszKchBQTcqw1DC09uD7i7vvMayHGM1OCo6AHt5pkgZEyo99ClhHTMJdf+Ezc9ovuNNxcH89QfyclGthjZJOw==",
25
+      "engines": {
26
+        "node": ">=6"
27
+      }
28
+    },
29
+    "node_modules/nan": {
30
+      "version": "2.15.0",
31
+      "resolved": "https://registry.npmjs.org/nan/-/nan-2.15.0.tgz",
32
+      "integrity": "sha512-8ZtvEnA2c5aYCZYd1cvgdnU6cqwixRoYg70xPLWUws5ORTa/lnw+u4amixRS/Ac5U5mQVgp9pnlSUnbNWFaWZQ==",
33
+      "optional": true
34
+    }
35
+  }
36
+}
... ...
@@ -0,0 +1,21 @@
1
+MIT License
2
+
3
+Copyright (C) 2011 by fent
4
+
5
+Permission is hereby granted, free of charge, to any person obtaining a copy
6
+of this software and associated documentation files (the "Software"), to deal
7
+in the Software without restriction, including without limitation the rights
8
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+copies of the Software, and to permit persons to whom the Software is
10
+furnished to do so, subject to the following conditions:
11
+
12
+The above copyright notice and this permission notice shall be included in
13
+all copies or substantial portions of the Software.
14
+
15
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+THE SOFTWARE. 
... ...
@@ -0,0 +1,85 @@
1
+# irc.colors.js
2
+
3
+Easily use colored output and formatting in your irc bots.
4
+
5
+[![Build Status](https://secure.travis-ci.org/fent/irc-colors.js.svg)](http://travis-ci.org/fent/irc-colors.js)
6
+[![Dependency Status](https://david-dm.org/fent/irc-colors.js.svg)](https://david-dm.org/fent/irc-colors.js)
7
+[![codecov](https://codecov.io/gh/fent/irc-colors.js/branch/master/graph/badge.svg)](https://codecov.io/gh/fent/irc-colors.js)
8
+
9
+
10
+
11
+# Usage
12
+
13
+```javascript
14
+const c = require('irc-colors');
15
+...
16
+ircbot.say('#chan', c.blue('hello everyone')); // prints blue text
17
+ircbot.say('#chan', c.underline.red('WARNING')); // can be chained
18
+ircbot.say('#chan', c.white.bgblack('inverted')); // white text with black background
19
+
20
+warn = c.bold.red.bgyellow;
21
+ircbot.say('#chan', warn('BIGGER WARNING')); // bold red text with yellow background
22
+ircbot.say('#chan', c.rainbow('having fun!'); // prints rainbow colored text
23
+```
24
+
25
+### But wait, there's more!
26
+
27
+If you don't mind changing the prototype of the String object, then use the global() function.
28
+
29
+```javascript
30
+require('irc-colors').global()
31
+...
32
+ircbot.say('#chan', 'say something'.irc.red()); // prints red text
33
+ircbot.say('#chan', 'hi everyone!'.irc.green.bold()); // prints green bold text
34
+ircbot.say('#chan', 'etc etc'.irc.underline.grey.bgblack()) // chains work too
35
+```
36
+
37
+Global syntax was inspired by [colors.js](https://github.com/marak/colors.js) and because of that, there's possibility that you might want to use that module along with this one. That's why the *irc* property of a String needs to be called first to use the formatting functions.
38
+
39
+
40
+## Colors
41
+
42
+![colors](img/colors.png)
43
+
44
+Original name or alternate can be used, without spaces
45
+
46
+    bot.say('#chat', c.bluecyan('hi'));
47
+
48
+
49
+## Styles
50
+
51
+![styles](img/styles.png)
52
+
53
+
54
+## Extras
55
+
56
+![extras](img/extras.png)
57
+
58
+## Strip
59
+
60
+You can also strip out any colors/style from IRC messages.
61
+
62
+* `stripColors`
63
+* `stripStyle`
64
+* `stripColorsAndStyle`
65
+
66
+```js
67
+const c = require('irc-colors');
68
+
69
+ircbot.on('message', (from, message) => {
70
+  console.log(c.stripColorsAndStyle(message));
71
+});
72
+```
73
+
74
+
75
+# Install
76
+
77
+    npm install irc-colors
78
+
79
+
80
+# Tests
81
+Tests are written with [vows](http://vowsjs.org/)
82
+
83
+```bash
84
+npm test
85
+```
... ...
@@ -0,0 +1,187 @@
1
+const colors = {
2
+  '00': ['white'],
3
+  '01': ['black'],
4
+  '02': ['navy'],
5
+  '03': ['green'],
6
+  '04': ['red'],
7
+  '05': ['brown', 'maroon'],
8
+  '06': ['purple', 'violet'],
9
+  '07': ['olive'],
10
+  '08': ['yellow'],
11
+  '09': ['lightgreen', 'lime'],
12
+  '10': ['teal', 'bluecyan'],
13
+  '11': ['cyan', 'aqua'],
14
+  '12': ['blue', 'royal'],
15
+  '13': ['pink', 'lightpurple', 'fuchsia'],
16
+  '14': ['gray', 'grey'],
17
+  '15': ['lightgray', 'lightgrey', 'silver']
18
+};
19
+
20
+const styles = {
21
+  normal        : '\x0F',
22
+  underline     : '\x1F',
23
+  bold          : '\x02',
24
+  italic        : '\x1D',
25
+  inverse       : '\x16',
26
+  strikethrough : '\x1E',
27
+  monospace     : '\x11',
28
+};
29
+
30
+const styleChars = {};
31
+Object.keys(styles).forEach((key) => {
32
+  styleChars[styles[key]] = true;
33
+});
34
+
35
+
36
+// Coloring character.
37
+const c = '\x03';
38
+const zero = styles.bold + styles.bold;
39
+const badStr = /^,\d/;
40
+const colorCodeStr = new RegExp(`^${c}\\d\\d`);
41
+
42
+const allColors = {
43
+  fg: [], bg: [], styles: Object.keys(styles), custom: [], extras: [],
44
+};
45
+
46
+// Make color functions for both foreground and background.
47
+Object.keys(colors).forEach((code) => {
48
+  // Foreground.
49
+  // If the string begins with /,\d/,
50
+  // it can undersirably apply a background color.
51
+  let fg = str => c + code + (badStr.test(str) ? zero : '') + str + c;
52
+
53
+  // Background.
54
+  let bg = (str) => {
55
+    // If the string begins with a foreground color already applied,
56
+    // use it to save string space.
57
+    if (colorCodeStr.test(str)) {
58
+      let str2 = str.substr(3);
59
+      return str.substr(0, 3) + ',' + code +
60
+        (str2.indexOf(zero) === 0 ? str2.substr(zero.length) : str2);
61
+    } else {
62
+      return c + '01,' + code + str + c;
63
+    }
64
+  };
65
+
66
+  colors[code].forEach((color) => {
67
+    allColors.fg.push(color);
68
+    allColors.bg.push('bg' + color);
69
+    exports[color] = fg;
70
+    exports['bg' + color] = bg;
71
+  });
72
+});
73
+
74
+// Style functions.
75
+Object.keys(styles).forEach((style) => {
76
+  let code = styles[style];
77
+  exports[style] = str => code + str + code;
78
+});
79
+
80
+// Some custom helpers.
81
+const custom = {
82
+  rainbow: (str, colorArr) => {
83
+    let rainbow = [
84
+      'red', 'olive', 'yellow', 'green', 'blue', 'navy', 'violet'
85
+    ];
86
+    colorArr = colorArr || rainbow;
87
+    let l = colorArr.length;
88
+    let i = 0;
89
+
90
+    return str
91
+      .split('')
92
+      .map(c => c !== ' ' ? exports[colorArr[i++ % l]](c) : c)
93
+      .join('');
94
+  },
95
+};
96
+
97
+Object.keys(custom).forEach((extra) => {
98
+  allColors.custom.push(extra);
99
+  exports[extra] = custom[extra];
100
+});
101
+
102
+// Extras.
103
+const extras = {
104
+  stripColors: str => str.replace(/\x03\d{0,2}(,\d{0,2}|\x02\x02)?/g, ''),
105
+
106
+  stripStyle: (str) => {
107
+    let path = [];
108
+    for (let i = 0, len = str.length; i < len; i++) {
109
+      let char = str[i];
110
+      if (styleChars[char] || char === c) {
111
+        let lastChar = path[path.length - 1];
112
+        if (lastChar && lastChar[0] === char) {
113
+          let p0 = lastChar[1];
114
+          // Don't strip out styles with no characters inbetween.
115
+          // And don't strip out color codes.
116
+          if (i - p0 > 1 && char !== c) {
117
+            str = str.slice(0, p0) + str.slice(p0 + 1, i) + str.slice(i + 1);
118
+            i -= 2;
119
+          }
120
+          path.pop();
121
+        } else {
122
+          path.push([str[i], i]);
123
+        }
124
+      }
125
+
126
+    }
127
+
128
+    // Remove any unmatching style characterss.
129
+    // Traverse list backwards to make removing less complicated.
130
+    for (let char of path.reverse()) {
131
+      if (char[0] !== c) {
132
+        let pos = char[1];
133
+        str = str.slice(0, pos) + str.slice(pos + 1);
134
+      }
135
+    }
136
+    return str;
137
+  },
138
+
139
+  stripColorsAndStyle: str => exports.stripColors(exports.stripStyle(str)),
140
+};
141
+
142
+Object.keys(extras).forEach((extra) => {
143
+  allColors.extras.push(extra);
144
+  exports[extra] = extras[extra];
145
+});
146
+
147
+// Adds all functions to each other so they can be chained.
148
+const addGetters = (fn, types) => {
149
+  Object.keys(allColors).forEach((type) => {
150
+    if (types.indexOf(type) > -1) { return; }
151
+    allColors[type].forEach((color) => {
152
+      if (fn[color] != null) { return; }
153
+      Object.defineProperty(fn, color, {
154
+        get: () => {
155
+          let f = str => exports[color](fn(str));
156
+          addGetters(f, [].concat(types, type));
157
+          return f;
158
+        },
159
+      });
160
+    });
161
+  });
162
+};
163
+
164
+Object.keys(allColors).forEach((type) => {
165
+  allColors[type].forEach((color) => {
166
+    addGetters(exports[color], [type]);
167
+  });
168
+});
169
+
170
+
171
+// Adds functions to global String object.
172
+exports.global = () => {
173
+  let str, irc = {};
174
+
175
+  String.prototype.__defineGetter__('irc', function() {
176
+    str = this;
177
+    return irc;
178
+  });
179
+
180
+  for (let type in allColors) {
181
+    allColors[type].forEach((color) => {
182
+      let fn = () => exports[color](str);
183
+      addGetters(fn, [type]);
184
+      irc[color] = fn;
185
+    });
186
+  }
187
+};
... ...
@@ -0,0 +1,33 @@
1
+{
2
+  "name": "irc-colors",
3
+  "description": "Color and formatting for irc made easy.",
4
+  "keywords": [
5
+    "irc",
6
+    "color",
7
+    "colour"
8
+  ],
9
+  "version": "1.5.0",
10
+  "repository": {
11
+    "type": "git",
12
+    "url": "git://github.com/fent/irc-colors.js.git"
13
+  },
14
+  "author": "fent (https://github.com/fent)",
15
+  "main": "./lib/irc-colors.js",
16
+  "files": [
17
+    "lib"
18
+  ],
19
+  "scripts": {
20
+    "test": "istanbul cover vows -- --spec test/*-test.js"
21
+  },
22
+  "directories": {
23
+    "lib": "./lib"
24
+  },
25
+  "devDependencies": {
26
+    "istanbul": "^0.4.5",
27
+    "vows": "^0.8.1"
28
+  },
29
+  "engines": {
30
+    "node": ">=6"
31
+  },
32
+  "license": "MIT"
33
+}
... ...
@@ -0,0 +1,7 @@
1
+{
2
+  "validateIndentation": 4,
3
+  "disallowMultipleVarDecl": null,
4
+  "requireMultipleVarDecl": null,
5
+  "requireCamelCaseOrUpperCaseIdentifiers": "ignoreProperties",
6
+  "safeContextKeyword": "self"
7
+}
... ...
@@ -0,0 +1,4 @@
1
+*.log
2
+node_modules/
3
+_build/
4
+.idea/
... ...
@@ -0,0 +1,16 @@
1
+language: node_js
2
+node_js:
3
+  - "0.10"
4
+  - "0.12"
5
+  - "4"
6
+  - "5"
7
+  - "6"
8
+  - "7"
9
+before_install:
10
+  - sudo apt-get -y install libicu-dev
11
+  - npm install -g npm
12
+script:
13
+  - "npm run-script lint"
14
+  - "npm test"
15
+notifications:
16
+  irc: "chat.freenode.net##node-irc"
... ...
@@ -0,0 +1,473 @@
1
+# Change Log
2
+
3
+## [v0.5.2](https://github.com/martynsmith/node-irc/tree/v0.5.2) (2016-11-25)
4
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.5.1...v0.5.2)
5
+
6
+**Merged pull requests:**
7
+
8
+- Update iconv to 2.2.1 and node-icu-charset-detector to 0.2.0 to fix node 6+ support [\#487](https://github.com/martynsmith/node-irc/pull/487) ([paladox](https://github.com/paladox))
9
+
10
+## [v0.5.1](https://github.com/martynsmith/node-irc/tree/v0.5.1) (2016-11-17)
11
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.5.0...v0.5.1)
12
+
13
+**Implemented enhancements:**
14
+
15
+- Detect ping timeout [\#76](https://github.com/martynsmith/node-irc/issues/76)
16
+
17
+**Fixed bugs:**
18
+
19
+- Call stack size exceeded [\#337](https://github.com/martynsmith/node-irc/issues/337)
20
+- Many servers do not send a meaningful hostname in 001 [\#288](https://github.com/martynsmith/node-irc/issues/288)
21
+- disconnect does not appear to send the reason to the server [\#89](https://github.com/martynsmith/node-irc/issues/89)
22
+
23
+**Closed issues:**
24
+
25
+- Creating a whitelist against the nickname  [\#484](https://github.com/martynsmith/node-irc/issues/484)
26
+- Deployed on Heroku, app is running, no IRC connection [\#481](https://github.com/martynsmith/node-irc/issues/481)
27
+- Install does not work on Debian stable. [\#475](https://github.com/martynsmith/node-irc/issues/475)
28
+- Non private reply with highlighted nick [\#474](https://github.com/martynsmith/node-irc/issues/474)
29
+- retryDelay not mentioned in the docs [\#446](https://github.com/martynsmith/node-irc/issues/446)
30
+- 'names' event returns only 10 nicks [\#414](https://github.com/martynsmith/node-irc/issues/414)
31
+- can't get chat messages [\#384](https://github.com/martynsmith/node-irc/issues/384)
32
+- parse message TypeError: Cannot read property '1' of null [\#331](https://github.com/martynsmith/node-irc/issues/331)
33
+- TypeError: No method channel [\#254](https://github.com/martynsmith/node-irc/issues/254)
34
+- Unable to connect to OFTC network over SSL [\#247](https://github.com/martynsmith/node-irc/issues/247)
35
+- Specific mode sequences can crash the bot [\#233](https://github.com/martynsmith/node-irc/issues/233)
36
+- Event listener ctcp-privmsg's "message" is empty [\#207](https://github.com/martynsmith/node-irc/issues/207)
37
+- Mass channel MODE with -lk throws error [\#177](https://github.com/martynsmith/node-irc/issues/177)
38
+
39
+**Merged pull requests:**
40
+
41
+- Respect opt.messageSplit when calculating message length [\#385](https://github.com/martynsmith/node-irc/pull/385) ([LinuxMercedes](https://github.com/LinuxMercedes))
42
+
43
+## [v0.5.0](https://github.com/martynsmith/node-irc/tree/v0.5.0) (2016-03-26)
44
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.4.1...v0.5.0)
45
+
46
+**Implemented enhancements:**
47
+
48
+- Allow tilde in nicks [\#438](https://github.com/martynsmith/node-irc/pull/438) ([hexjelly](https://github.com/hexjelly))
49
+
50
+**Fixed bugs:**
51
+
52
+- Fixes \#427 [\#429](https://github.com/martynsmith/node-irc/pull/429) ([ghost](https://github.com/ghost))
53
+
54
+**Closed issues:**
55
+
56
+- How to get current server. [\#453](https://github.com/martynsmith/node-irc/issues/453)
57
+- Library never connects to server  [\#451](https://github.com/martynsmith/node-irc/issues/451)
58
+- Ping timeout causes double reconnect [\#449](https://github.com/martynsmith/node-irc/issues/449)
59
+- Changelog for v4.0? [\#435](https://github.com/martynsmith/node-irc/issues/435)
60
+- How to multiple server connections at the same time [\#434](https://github.com/martynsmith/node-irc/issues/434)
61
+- Add connected flag [\#430](https://github.com/martynsmith/node-irc/issues/430)
62
+- Add link to docs on github wiki page [\#422](https://github.com/martynsmith/node-irc/issues/422)
63
+- maxLineLength is not set by default and can crash the bot [\#419](https://github.com/martynsmith/node-irc/issues/419)
64
+- PING/PONG Error! [\#415](https://github.com/martynsmith/node-irc/issues/415)
65
+- quit event provides wrong channel information [\#398](https://github.com/martynsmith/node-irc/issues/398)
66
+- Detect client timeout ? [\#375](https://github.com/martynsmith/node-irc/issues/375)
67
+- User MODE changes are not being received in +MODE/-MODE handlers [\#374](https://github.com/martynsmith/node-irc/issues/374)
68
+- Error client.say\(nick, "record\\w3xp\\random\\wins"\); [\#369](https://github.com/martynsmith/node-irc/issues/369)
69
+- SASL over SSL never happens [\#250](https://github.com/martynsmith/node-irc/issues/250)
70
+- Message Events Ignored [\#242](https://github.com/martynsmith/node-irc/issues/242)
71
+- Bot crashes on mode +q-o [\#221](https://github.com/martynsmith/node-irc/issues/221)
72
+- Cannot pass MODE command with multiple arguments [\#147](https://github.com/martynsmith/node-irc/issues/147)
73
+- Certain MODE messages could access on undefined [\#144](https://github.com/martynsmith/node-irc/issues/144)
74
+- mode emit event [\#136](https://github.com/martynsmith/node-irc/issues/136)
75
+- QUIT, KILL removes users from user list before processing event hooks [\#73](https://github.com/martynsmith/node-irc/issues/73)
76
+
77
+**Merged pull requests:**
78
+
79
+- fix\(ping timeouts\): When a ping timeout is detected properly destroy … [\#452](https://github.com/martynsmith/node-irc/pull/452) ([jirwin](https://github.com/jirwin))
80
+- Added link to install instructions for ICU [\#450](https://github.com/martynsmith/node-irc/pull/450) ([spalger](https://github.com/spalger))
81
+- User status isn't updated on MODE if he's not VOICE or OP [\#448](https://github.com/martynsmith/node-irc/pull/448) ([Zoddo](https://github.com/Zoddo))
82
+- Add a Gitter chat badge to README.md [\#444](https://github.com/martynsmith/node-irc/pull/444) ([gitter-badger](https://github.com/gitter-badger))
83
+- Detect and recover from ping timeouts [\#418](https://github.com/martynsmith/node-irc/pull/418) ([philip-peterson](https://github.com/philip-peterson))
84
+- Adding support for command rpl\_whoreply \(352\) [\#413](https://github.com/martynsmith/node-irc/pull/413) ([lan17](https://github.com/lan17))
85
+- Update .gitignore [\#373](https://github.com/martynsmith/node-irc/pull/373) ([Phalanxia](https://github.com/Phalanxia))
86
+- Update license attribute [\#372](https://github.com/martynsmith/node-irc/pull/372) ([pdehaan](https://github.com/pdehaan))
87
+
88
+## [v0.4.1](https://github.com/martynsmith/node-irc/tree/v0.4.1) (2016-01-27)
89
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.4.0...v0.4.1)
90
+
91
+**Implemented enhancements:**
92
+
93
+- Dealing with OPER command replies. [\#439](https://github.com/martynsmith/node-irc/pull/439) ([ellisgl](https://github.com/ellisgl))
94
+
95
+**Fixed bugs:**
96
+
97
+- Fix SASL auth [\#443](https://github.com/martynsmith/node-irc/pull/443) ([ggreer](https://github.com/ggreer))
98
+
99
+**Closed issues:**
100
+
101
+- Can't use it sadly [\#433](https://github.com/martynsmith/node-irc/issues/433)
102
+- how do I auto reconnect if the server goes down? [\#431](https://github.com/martynsmith/node-irc/issues/431)
103
+- WebIRC Support [\#427](https://github.com/martynsmith/node-irc/issues/427)
104
+- Error Handling Improvements \(all errors should gracefully fail\)   [\#421](https://github.com/martynsmith/node-irc/issues/421)
105
+- client.send\(\) always include : in first text [\#420](https://github.com/martynsmith/node-irc/issues/420)
106
+- node-irc with express/socket.io [\#417](https://github.com/martynsmith/node-irc/issues/417)
107
+- Not enough parameters' [\#416](https://github.com/martynsmith/node-irc/issues/416)
108
+- Help with error [\#393](https://github.com/martynsmith/node-irc/issues/393)
109
+-  Microsoft Visual Studio needed to install this in windoze [\#390](https://github.com/martynsmith/node-irc/issues/390)
110
+- oper command [\#234](https://github.com/martynsmith/node-irc/issues/234)
111
+
112
+**Merged pull requests:**
113
+
114
+- Remove \#blah from the example [\#440](https://github.com/martynsmith/node-irc/pull/440) ([ben-rabid](https://github.com/ben-rabid))
115
+- Move dependency 'ansi-color' to devDependencies [\#407](https://github.com/martynsmith/node-irc/pull/407) ([ho-ho-ho](https://github.com/ho-ho-ho))
116
+
117
+## [v0.4.0](https://github.com/martynsmith/node-irc/tree/v0.4.0) (2015-09-30)
118
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.12...v0.4.0)
119
+
120
+**Fixed bugs:**
121
+
122
+- Fix compile warnings on node v4 [\#409](https://github.com/martynsmith/node-irc/pull/409) ([feross](https://github.com/feross))
123
+
124
+**Closed issues:**
125
+
126
+- Error: Cannot enqueue Handshake after already enqueuing a Handshake. [\#404](https://github.com/martynsmith/node-irc/issues/404)
127
+- How to get current Config? [\#401](https://github.com/martynsmith/node-irc/issues/401)
128
+- Error Installing [\#400](https://github.com/martynsmith/node-irc/issues/400)
129
+- maxLineLength undefined when splitting long lines [\#395](https://github.com/martynsmith/node-irc/issues/395)
130
+- Package 'ansi-color' not found [\#389](https://github.com/martynsmith/node-irc/issues/389)
131
+- speak function bug, can't compile [\#388](https://github.com/martynsmith/node-irc/issues/388)
132
+- Error undefined nick [\#371](https://github.com/martynsmith/node-irc/issues/371)
133
+- Send CustomCommand to server [\#367](https://github.com/martynsmith/node-irc/issues/367)
134
+- The framework constantly crashes - "Cannot call method 'replace' of undefined" [\#364](https://github.com/martynsmith/node-irc/issues/364)
135
+- Trying to make a bot and can't figure out how to kick and do other op tasks [\#363](https://github.com/martynsmith/node-irc/issues/363)
136
+- Update Client.chans on change MODE [\#361](https://github.com/martynsmith/node-irc/issues/361)
137
+- Can node-irc determine who is a mod? [\#340](https://github.com/martynsmith/node-irc/issues/340)
138
+- Config with Password? [\#336](https://github.com/martynsmith/node-irc/issues/336)
139
+- Update node-icu-charset-detector version for nodejs 0.12 compatibility [\#332](https://github.com/martynsmith/node-irc/issues/332)
140
+- \[Question\] Timestamps or how much time a user has been connected? [\#321](https://github.com/martynsmith/node-irc/issues/321)
141
+
142
+**Merged pull requests:**
143
+
144
+- Bug fix: 'pm' event wouldnt always be trigged [\#397](https://github.com/martynsmith/node-irc/pull/397) ([ravenstar](https://github.com/ravenstar))
145
+- Call updateMaxLineLength on connection [\#396](https://github.com/martynsmith/node-irc/pull/396) ([secretrobotron](https://github.com/secretrobotron))
146
+- Fix typo. [\#383](https://github.com/martynsmith/node-irc/pull/383) ([schmich](https://github.com/schmich))
147
+- SyntaxError: Octal literals are not allowed in strict mode. [\#368](https://github.com/martynsmith/node-irc/pull/368) ([tom--](https://github.com/tom--))
148
+- Fix channel user modes on Twitch IRC \(closes \#364\) [\#366](https://github.com/martynsmith/node-irc/pull/366) ([sim642](https://github.com/sim642))
149
+
150
+## [v0.3.12](https://github.com/martynsmith/node-irc/tree/v0.3.12) (2015-04-25)
151
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.11...v0.3.12)
152
+
153
+**Closed issues:**
154
+
155
+- Document 'selfMessage' from \#17 [\#349](https://github.com/martynsmith/node-irc/issues/349)
156
+- Random crash after rpl\_luserunknown [\#342](https://github.com/martynsmith/node-irc/issues/342)
157
+
158
+**Merged pull requests:**
159
+
160
+- Cosmetics: fix minor spelling mistakes \[ci skip\] [\#356](https://github.com/martynsmith/node-irc/pull/356) ([vBm](https://github.com/vBm))
161
+- Travis: Sort supported node versions [\#355](https://github.com/martynsmith/node-irc/pull/355) ([vBm](https://github.com/vBm))
162
+- Readme: Add badges for npm version, dependency status and license [\#354](https://github.com/martynsmith/node-irc/pull/354) ([vBm](https://github.com/vBm))
163
+- Fix for unrealircd auditorium [\#352](https://github.com/martynsmith/node-irc/pull/352) ([PNWebster](https://github.com/PNWebster))
164
+- Add information about action events in the docs [\#350](https://github.com/martynsmith/node-irc/pull/350) ([ekmartin](https://github.com/ekmartin))
165
+- Fix charset conversion for invalid charsets  [\#347](https://github.com/martynsmith/node-irc/pull/347) ([aivot-on](https://github.com/aivot-on))
166
+- fix\(travis\): Add node 0.12 and iojs to travis. [\#333](https://github.com/martynsmith/node-irc/pull/333) ([jirwin](https://github.com/jirwin))
167
+
168
+## [v0.3.11](https://github.com/martynsmith/node-irc/tree/v0.3.11) (2015-04-06)
169
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.10...v0.3.11)
170
+
171
+## [v0.3.10](https://github.com/martynsmith/node-irc/tree/v0.3.10) (2015-04-02)
172
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.9...v0.3.10)
173
+
174
+**Closed issues:**
175
+
176
+- Error with node-icu-charset-detector [\#327](https://github.com/martynsmith/node-irc/issues/327)
177
+- Cannot call method 'match' of undefined [\#326](https://github.com/martynsmith/node-irc/issues/326)
178
+- TypeError: Cannot read property '1' of null [\#325](https://github.com/martynsmith/node-irc/issues/325)
179
+- Crashes if channel is undefined on say command [\#314](https://github.com/martynsmith/node-irc/issues/314)
180
+- Issue installing on OS X Mavericks [\#308](https://github.com/martynsmith/node-irc/issues/308)
181
+
182
+**Merged pull requests:**
183
+
184
+- Fixed case sensitivity bug in client.whois\(\) [\#338](https://github.com/martynsmith/node-irc/pull/338) ([itsrachelfish](https://github.com/itsrachelfish))
185
+- fix\(deps\): Upgrade node-icu to 0.1.0 for v0.12 support. [\#334](https://github.com/martynsmith/node-irc/pull/334) ([jirwin](https://github.com/jirwin))
186
+- Update API documentation with missing event and internal variable [\#330](https://github.com/martynsmith/node-irc/pull/330) ([RyanMorrison04](https://github.com/RyanMorrison04))
187
+- Documentation improvements [\#323](https://github.com/martynsmith/node-irc/pull/323) ([TimothyGu](https://github.com/TimothyGu))
188
+- fix blank lines being passed to parse message [\#318](https://github.com/martynsmith/node-irc/pull/318) ([helderroem](https://github.com/helderroem))
189
+- Rember to add path.resolve while requiring things! [\#316](https://github.com/martynsmith/node-irc/pull/316) ([Palid](https://github.com/Palid))
190
+- Fix option handling when passing a secure object [\#311](https://github.com/martynsmith/node-irc/pull/311) ([masochist](https://github.com/masochist))
191
+- Added a bit more information about Client.chans [\#310](https://github.com/martynsmith/node-irc/pull/310) ([itsrachelfish](https://github.com/itsrachelfish))
192
+
193
+## [v0.3.9](https://github.com/martynsmith/node-irc/tree/v0.3.9) (2015-01-16)
194
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.8...v0.3.9)
195
+
196
+**Implemented enhancements:**
197
+
198
+- Factor out test data into a fixtures file. [\#302](https://github.com/martynsmith/node-irc/pull/302) ([masochist](https://github.com/masochist))
199
+
200
+**Fixed bugs:**
201
+
202
+- Fix TLS connections. [\#304](https://github.com/martynsmith/node-irc/pull/304) ([masochist](https://github.com/masochist))
203
+
204
+**Closed issues:**
205
+
206
+- Please add feature for IRCv3 message tags! [\#298](https://github.com/martynsmith/node-irc/issues/298)
207
+- Switch to irc-color [\#297](https://github.com/martynsmith/node-irc/issues/297)
208
+- SSL Broken as of v0.3.8 [\#296](https://github.com/martynsmith/node-irc/issues/296)
209
+- Version 0.3.8 failed while using hubot-irc [\#289](https://github.com/martynsmith/node-irc/issues/289)
210
+- Loading self signed certs [\#262](https://github.com/martynsmith/node-irc/issues/262)
211
+- 0.3.x : 'nicknameinuse' event missing [\#258](https://github.com/martynsmith/node-irc/issues/258)
212
+- Is there an autoConnect callback? [\#239](https://github.com/martynsmith/node-irc/issues/239)
213
+
214
+**Merged pull requests:**
215
+
216
+- Log net connection errors. Thanks Trinitas. [\#307](https://github.com/martynsmith/node-irc/pull/307) ([jirwin](https://github.com/jirwin))
217
+- Bring in irc-colors for stripping colors [\#306](https://github.com/martynsmith/node-irc/pull/306) ([masochist](https://github.com/masochist))
218
+- do not autorejoin on kicks. bad bot! no cookie! [\#303](https://github.com/martynsmith/node-irc/pull/303) ([masochist](https://github.com/masochist))
219
+- fix\(style\): Clean up various style issues in irc.js [\#299](https://github.com/martynsmith/node-irc/pull/299) ([jirwin](https://github.com/jirwin))
220
+- Write a test for setting the hostmask when nick is in use [\#294](https://github.com/martynsmith/node-irc/pull/294) ([masochist](https://github.com/masochist))
221
+- fix\(parseMessage\): Factor parseMessage to another file for decoupling. [\#293](https://github.com/martynsmith/node-irc/pull/293) ([jirwin](https://github.com/jirwin))
222
+- Set self.hostMask to the empty string to elegantly solve \#286 [\#292](https://github.com/martynsmith/node-irc/pull/292) ([masochist](https://github.com/masochist))
223
+- First draft of contributing doc [\#287](https://github.com/martynsmith/node-irc/pull/287) ([masochist](https://github.com/masochist))
224
+- Fix data split delimiter [\#280](https://github.com/martynsmith/node-irc/pull/280) ([ota42y](https://github.com/ota42y))
225
+
226
+## [v0.3.8](https://github.com/martynsmith/node-irc/tree/v0.3.8) (2015-01-09)
227
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.7...v0.3.8)
228
+
229
+**Fixed bugs:**
230
+
231
+- Client.whois on nick not in use crashes bot running with v.0.3.3 [\#267](https://github.com/martynsmith/node-irc/issues/267)
232
+
233
+**Closed issues:**
234
+
235
+- Documentation on RTD gone? [\#264](https://github.com/martynsmith/node-irc/issues/264)
236
+- Allow passworded IRC connections [\#263](https://github.com/martynsmith/node-irc/issues/263)
237
+- Parse RPL\_CREATIONTIME [\#260](https://github.com/martynsmith/node-irc/issues/260)
238
+- News from 0.3.x? [\#259](https://github.com/martynsmith/node-irc/issues/259)
239
+- The master branch is not up to date with npm [\#257](https://github.com/martynsmith/node-irc/issues/257)
240
+- Browserify support? [\#253](https://github.com/martynsmith/node-irc/issues/253)
241
+- self.chan and self.chandata events [\#243](https://github.com/martynsmith/node-irc/issues/243)
242
+
243
+**Merged pull requests:**
244
+
245
+- fix\(webirc\): Set sane defaults for WEBIRC options. [\#283](https://github.com/martynsmith/node-irc/pull/283) ([jirwin](https://github.com/jirwin))
246
+- WIP: fix\(tests\): A first attempt at a sane pattern to begin testing the handling of the protocol. [\#282](https://github.com/martynsmith/node-irc/pull/282) ([jirwin](https://github.com/jirwin))
247
+- fix\(irc.js\): Use the proper EventEmitter class. [\#281](https://github.com/martynsmith/node-irc/pull/281) ([jirwin](https://github.com/jirwin))
248
+- Update colors.js [\#279](https://github.com/martynsmith/node-irc/pull/279) ([bcome](https://github.com/bcome))
249
+- Optional encoding option [\#278](https://github.com/martynsmith/node-irc/pull/278) ([tarlepp](https://github.com/tarlepp))
250
+- WEBIRC support [\#276](https://github.com/martynsmith/node-irc/pull/276) ([Trinitas](https://github.com/Trinitas))
251
+- fix\(style\): Remove folding hints from codes and irc. [\#275](https://github.com/martynsmith/node-irc/pull/275) ([jirwin](https://github.com/jirwin))
252
+- fix\(tests\): Ditch mocha and should for tape! [\#274](https://github.com/martynsmith/node-irc/pull/274) ([jirwin](https://github.com/jirwin))
253
+- Add travis with lint and tests [\#271](https://github.com/martynsmith/node-irc/pull/271) ([jirwin](https://github.com/jirwin))
254
+- Add proper long line wrapping. [\#268](https://github.com/martynsmith/node-irc/pull/268) ([masochist](https://github.com/masochist))
255
+- update README regarding npm and the 0.3.x branch [\#256](https://github.com/martynsmith/node-irc/pull/256) ([mbouchenoire](https://github.com/mbouchenoire))
256
+- Updated API information [\#240](https://github.com/martynsmith/node-irc/pull/240) ([Hydrothermal](https://github.com/Hydrothermal))
257
+- Add option to specify bind address when connecting [\#146](https://github.com/martynsmith/node-irc/pull/146) ([revmischa](https://github.com/revmischa))
258
+
259
+## [v0.3.7](https://github.com/martynsmith/node-irc/tree/v0.3.7) (2014-05-29)
260
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.5...v0.3.7)
261
+
262
+**Closed issues:**
263
+
264
+- Sending nick out of sequence can cause exceptions [\#235](https://github.com/martynsmith/node-irc/issues/235)
265
+- Events need a different approach [\#231](https://github.com/martynsmith/node-irc/issues/231)
266
+- Check if an user is a voice, half-operator, operator,... [\#230](https://github.com/martynsmith/node-irc/issues/230)
267
+- my script throws error "You have not registered" [\#229](https://github.com/martynsmith/node-irc/issues/229)
268
+- Cannot call method 'indexOf' of undefined [\#227](https://github.com/martynsmith/node-irc/issues/227)
269
+- I need SPEED ! [\#223](https://github.com/martynsmith/node-irc/issues/223)
270
+- With stripColors: true set, a post only containing control characters, such as color or bold crashes the library [\#218](https://github.com/martynsmith/node-irc/issues/218)
271
+- Bot Disconnects Every 10 Minutes [\#215](https://github.com/martynsmith/node-irc/issues/215)
272
+- State of project [\#213](https://github.com/martynsmith/node-irc/issues/213)
273
+- add the 'action' event to the documentation [\#212](https://github.com/martynsmith/node-irc/issues/212)
274
+- line ending problem: module does not support UNIX Line Ending [\#208](https://github.com/martynsmith/node-irc/issues/208)
275
+- identify command? [\#205](https://github.com/martynsmith/node-irc/issues/205)
276
+- looking for a maintainer? [\#197](https://github.com/martynsmith/node-irc/issues/197)
277
+- pm only works with mirc clients? [\#196](https://github.com/martynsmith/node-irc/issues/196)
278
+- message time [\#195](https://github.com/martynsmith/node-irc/issues/195)
279
+- Ping Pong idea [\#194](https://github.com/martynsmith/node-irc/issues/194)
280
+- examples not working [\#193](https://github.com/martynsmith/node-irc/issues/193)
281
+- Code reuse and license compliance [\#192](https://github.com/martynsmith/node-irc/issues/192)
282
+- Pull requests building up in backlog [\#189](https://github.com/martynsmith/node-irc/issues/189)
283
+- Bold text [\#185](https://github.com/martynsmith/node-irc/issues/185)
284
+- Support for server-time extension [\#184](https://github.com/martynsmith/node-irc/issues/184)
285
+- client.removeListener [\#180](https://github.com/martynsmith/node-irc/issues/180)
286
+- Adding callback to say\(\) method of Node IRC client [\#179](https://github.com/martynsmith/node-irc/issues/179)
287
+- Getting "Assertion failed" error with secure:true flag [\#178](https://github.com/martynsmith/node-irc/issues/178)
288
+- PRIVMSG that starts with : causes crash [\#173](https://github.com/martynsmith/node-irc/issues/173)
289
+- MODE change resulting in constant crash [\#171](https://github.com/martynsmith/node-irc/issues/171)
290
+- client.addListener\("message\#Channel" bug [\#169](https://github.com/martynsmith/node-irc/issues/169)
291
+- Reconnection fails because of nick modification [\#168](https://github.com/martynsmith/node-irc/issues/168)
292
+- When sending NICK command, the channel returned is lowercase [\#167](https://github.com/martynsmith/node-irc/issues/167)
293
+- Crash when using NAMES command [\#163](https://github.com/martynsmith/node-irc/issues/163)
294
+- Incompatible with Node 0.10.x with `secure` is `true` [\#160](https://github.com/martynsmith/node-irc/issues/160)
295
+- Handling ISO-8859-1 characters [\#157](https://github.com/martynsmith/node-irc/issues/157)
296
+- Cannot login to twitch irc [\#156](https://github.com/martynsmith/node-irc/issues/156)
297
+- Problem with connecting to Inspircd server [\#154](https://github.com/martynsmith/node-irc/issues/154)
298
+- Method for specifying the user's hostname [\#153](https://github.com/martynsmith/node-irc/issues/153)
299
+- Limit output [\#152](https://github.com/martynsmith/node-irc/issues/152)
300
+- Change nick at runtime? [\#149](https://github.com/martynsmith/node-irc/issues/149)
301
+- how to connect with a server password for twitchtv/justintv? [\#148](https://github.com/martynsmith/node-irc/issues/148)
302
+- please delete it [\#141](https://github.com/martynsmith/node-irc/issues/141)
303
+- Ensure QUIT message is processed correctly when using flood protection [\#138](https://github.com/martynsmith/node-irc/issues/138)
304
+- add connection parameters to include userName and realName [\#135](https://github.com/martynsmith/node-irc/issues/135)
305
+- Add an 'action' event [\#134](https://github.com/martynsmith/node-irc/issues/134)
306
+- chat server connection errors [\#127](https://github.com/martynsmith/node-irc/issues/127)
307
+- CTCP event should provide message object \(similar to message\# event\) [\#126](https://github.com/martynsmith/node-irc/issues/126)
308
+- new npm release? [\#124](https://github.com/martynsmith/node-irc/issues/124)
309
+- MODE messages don't appear to work correctly with JustinTV/TwitchTV chat. [\#123](https://github.com/martynsmith/node-irc/issues/123)
310
+- Colons in user messages cause issues [\#122](https://github.com/martynsmith/node-irc/issues/122)
311
+- rpl\_channelmodeis messages are not parsed correctly [\#120](https://github.com/martynsmith/node-irc/issues/120)
312
+- Issue with Non-ASCII Nick [\#104](https://github.com/martynsmith/node-irc/issues/104)
313
+
314
+**Merged pull requests:**
315
+
316
+- Fixes \#235 type error where channel does not exist [\#236](https://github.com/martynsmith/node-irc/pull/236) ([qq99](https://github.com/qq99))
317
+- support for use\_strict [\#228](https://github.com/martynsmith/node-irc/pull/228) ([tedgoddard](https://github.com/tedgoddard))
318
+- Fixed irc not connecting to selfsigned servers [\#201](https://github.com/martynsmith/node-irc/pull/201) ([antonva](https://github.com/antonva))
319
+- added 'err\_erroneusnickname' message case' [\#191](https://github.com/martynsmith/node-irc/pull/191) ([redshark1802](https://github.com/redshark1802))
320
+- fix\(package.json\): Add ansi-color to the package dependencies. [\#188](https://github.com/martynsmith/node-irc/pull/188) ([jirwin](https://github.com/jirwin))
321
+- fix\(lib/irc\): Use protected loops when iterating channels to remove users [\#187](https://github.com/martynsmith/node-irc/pull/187) ([jirwin](https://github.com/jirwin))
322
+- Fix the color wrap function [\#186](https://github.com/martynsmith/node-irc/pull/186) ([cattode](https://github.com/cattode))
323
+- Hide 'Sending irc NICK/User' debug msg [\#183](https://github.com/martynsmith/node-irc/pull/183) ([porjo](https://github.com/porjo))
324
+- Added bold/underline "colors" [\#170](https://github.com/martynsmith/node-irc/pull/170) ([BenjaminRH](https://github.com/BenjaminRH))
325
+- Fix Cient.join: when user specify a password [\#166](https://github.com/martynsmith/node-irc/pull/166) ([macpie](https://github.com/macpie))
326
+- Fix a crash bug when a zero length message is received [\#165](https://github.com/martynsmith/node-irc/pull/165) ([shiwano](https://github.com/shiwano))
327
+- Change to be a non-existing server/channel [\#162](https://github.com/martynsmith/node-irc/pull/162) ([chilts](https://github.com/chilts))
328
+- Add support for client certificates in connection handling [\#161](https://github.com/martynsmith/node-irc/pull/161) ([squeeks](https://github.com/squeeks))
329
+- fixed a small typo for util.log\(\) on MODE change [\#158](https://github.com/martynsmith/node-irc/pull/158) ([JohnMaguire](https://github.com/JohnMaguire))
330
+- Fix: codes variable is leaked to global scope [\#155](https://github.com/martynsmith/node-irc/pull/155) ([garyc40](https://github.com/garyc40))
331
+- Added user message support for PART [\#140](https://github.com/martynsmith/node-irc/pull/140) ([qsheets](https://github.com/qsheets))
332
+- Fix for receiving messages with colons [\#137](https://github.com/martynsmith/node-irc/pull/137) ([qsheets](https://github.com/qsheets))
333
+- add names for five numerics; fix handling of 002 and 003 [\#131](https://github.com/martynsmith/node-irc/pull/131) ([rwg](https://github.com/rwg))
334
+- provide message object to ctcp events [\#130](https://github.com/martynsmith/node-irc/pull/130) ([damianb](https://github.com/damianb))
335
+- add names\#channel event [\#129](https://github.com/martynsmith/node-irc/pull/129) ([ydnax](https://github.com/ydnax))
336
+- Added SASL support [\#125](https://github.com/martynsmith/node-irc/pull/125) ([gsf](https://github.com/gsf))
337
+
338
+## [v0.3.5](https://github.com/martynsmith/node-irc/tree/v0.3.5) (2013-01-01)
339
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.3...v0.3.5)
340
+
341
+**Closed issues:**
342
+
343
+- How to handle disconnects? [\#117](https://github.com/martynsmith/node-irc/issues/117)
344
+- opping and kicking on freenode.net [\#110](https://github.com/martynsmith/node-irc/issues/110)
345
+- 'LOAD' event issue?  [\#108](https://github.com/martynsmith/node-irc/issues/108)
346
+- TOPIC command doesn't play nicely with send function [\#98](https://github.com/martynsmith/node-irc/issues/98)
347
+- Add support for more channel types [\#97](https://github.com/martynsmith/node-irc/issues/97)
348
+- Passing a large array of channels causes flood kick [\#96](https://github.com/martynsmith/node-irc/issues/96)
349
+- Issuing NICK during session breaks JOIN [\#93](https://github.com/martynsmith/node-irc/issues/93)
350
+- Make Client writable/readable stream? [\#92](https://github.com/martynsmith/node-irc/issues/92)
351
+- whois + host with IPv6 leads to info.host = '0' [\#90](https://github.com/martynsmith/node-irc/issues/90)
352
+- Sending PASS to password protected irc server prepends : [\#87](https://github.com/martynsmith/node-irc/issues/87)
353
+- 'invite' not emitted [\#86](https://github.com/martynsmith/node-irc/issues/86)
354
+- uncaught error on data listener [\#83](https://github.com/martynsmith/node-irc/issues/83)
355
+- Disable stdout for server events without specific listeners [\#78](https://github.com/martynsmith/node-irc/issues/78)
356
+- Handle server connection failures gracefully [\#74](https://github.com/martynsmith/node-irc/issues/74)
357
+- Emit mode change events [\#70](https://github.com/martynsmith/node-irc/issues/70)
358
+- Emit channels for "kill" like for "quit" [\#69](https://github.com/martynsmith/node-irc/issues/69)
359
+- Handle errors when parsing message [\#64](https://github.com/martynsmith/node-irc/issues/64)
360
+- Event on successful pm [\#56](https://github.com/martynsmith/node-irc/issues/56)
361
+- \[Feature request\] Automatic flood protection [\#36](https://github.com/martynsmith/node-irc/issues/36)
362
+- refactor node-irc to emit only one 'event' object [\#18](https://github.com/martynsmith/node-irc/issues/18)
363
+
364
+**Merged pull requests:**
365
+
366
+- Added library support for the RPL\_ISUPPORT server reply [\#114](https://github.com/martynsmith/node-irc/pull/114) ([qsheets](https://github.com/qsheets))
367
+- Fixed the message splitting on Client.say [\#112](https://github.com/martynsmith/node-irc/pull/112) ([Pumpuli](https://github.com/Pumpuli))
368
+- Fixed the message object being modified on MODE command. [\#111](https://github.com/martynsmith/node-irc/pull/111) ([Pumpuli](https://github.com/Pumpuli))
369
+- Add option to split long messages into multiple PRIVMSG calls [\#106](https://github.com/martynsmith/node-irc/pull/106) ([PherricOxide](https://github.com/PherricOxide))
370
+- Restore Fix for: Handle unverifiable self-signed certificates. [\#102](https://github.com/martynsmith/node-irc/pull/102) ([4poc](https://github.com/4poc))
371
+- If needed, update self.nick when NICK is received [\#94](https://github.com/martynsmith/node-irc/pull/94) ([toolness](https://github.com/toolness))
372
+- This fixes the IPv6-Issue \#90 for me. [\#91](https://github.com/martynsmith/node-irc/pull/91) ([ccoenen](https://github.com/ccoenen))
373
+- Make flood protection timeout setting configurable. [\#84](https://github.com/martynsmith/node-irc/pull/84) ([lewinski](https://github.com/lewinski))
374
+- Event emiter for bad connection [\#77](https://github.com/martynsmith/node-irc/pull/77) ([akavlie](https://github.com/akavlie))
375
+- Include channels user was in when 'kill' is emitted [\#72](https://github.com/martynsmith/node-irc/pull/72) ([alexwhitman](https://github.com/alexwhitman))
376
+- Emit +mode and -mode on mode changes [\#71](https://github.com/martynsmith/node-irc/pull/71) ([alexwhitman](https://github.com/alexwhitman))
377
+- Fix problem with 'QUIT' command [\#68](https://github.com/martynsmith/node-irc/pull/68) ([tapichu](https://github.com/tapichu))
378
+- Emit 'message\#' for a channel message [\#67](https://github.com/martynsmith/node-irc/pull/67) ([alexwhitman](https://github.com/alexwhitman))
379
+- Include message object with emits [\#66](https://github.com/martynsmith/node-irc/pull/66) ([alexwhitman](https://github.com/alexwhitman))
380
+- add some simple CTCP support [\#58](https://github.com/martynsmith/node-irc/pull/58) ([thejh](https://github.com/thejh))
381
+- Updating the certExpired option [\#53](https://github.com/martynsmith/node-irc/pull/53) ([jonrohan](https://github.com/jonrohan))
382
+
383
+## [v0.3.3](https://github.com/martynsmith/node-irc/tree/v0.3.3) (2011-11-16)
384
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.2...v0.3.3)
385
+
386
+**Closed issues:**
387
+
388
+- Race condition, mode+- before mode= seems to cause crash [\#65](https://github.com/martynsmith/node-irc/issues/65)
389
+- SSL Failed to connect [\#60](https://github.com/martynsmith/node-irc/issues/60)
390
+- "kill" emits no event [\#59](https://github.com/martynsmith/node-irc/issues/59)
391
+- NAMES command crashes client on InspIRCd-2.0 servers [\#55](https://github.com/martynsmith/node-irc/issues/55)
392
+- Traceback after joining network in 0.3.1 [\#50](https://github.com/martynsmith/node-irc/issues/50)
393
+- Handle erroneous commands gracefully [\#48](https://github.com/martynsmith/node-irc/issues/48)
394
+- Automatic NickServ /IDENTIFYcation? [\#47](https://github.com/martynsmith/node-irc/issues/47)
395
+
396
+**Merged pull requests:**
397
+
398
+- Handle errors in rpl\_namreply. [\#62](https://github.com/martynsmith/node-irc/pull/62) ([schwuk](https://github.com/schwuk))
399
+- Handle unverifiable self-signed certificates. [\#61](https://github.com/martynsmith/node-irc/pull/61) ([schwuk](https://github.com/schwuk))
400
+- Password support [\#51](https://github.com/martynsmith/node-irc/pull/51) ([wraithan](https://github.com/wraithan))
401
+
402
+## [v0.3.2](https://github.com/martynsmith/node-irc/tree/v0.3.2) (2011-10-30)
403
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.1...v0.3.2)
404
+
405
+## [v0.3.1](https://github.com/martynsmith/node-irc/tree/v0.3.1) (2011-10-29)
406
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.3.0...v0.3.1)
407
+
408
+## [v0.3.0](https://github.com/martynsmith/node-irc/tree/v0.3.0) (2011-10-28)
409
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.2.1...v0.3.0)
410
+
411
+**Closed issues:**
412
+
413
+- Add command for listing channels [\#42](https://github.com/martynsmith/node-irc/issues/42)
414
+- Parse /version instead of hardcoded symbols in MODE [\#40](https://github.com/martynsmith/node-irc/issues/40)
415
+- Channel letter-case crashes client [\#39](https://github.com/martynsmith/node-irc/issues/39)
416
+- Cannot read property 'users' of undefined [\#38](https://github.com/martynsmith/node-irc/issues/38)
417
+
418
+**Merged pull requests:**
419
+
420
+- Update package.json [\#45](https://github.com/martynsmith/node-irc/pull/45) ([chilts](https://github.com/chilts))
421
+- Added optional callbacks to connect and disconnect [\#44](https://github.com/martynsmith/node-irc/pull/44) ([fent](https://github.com/fent))
422
+- stripColors option [\#43](https://github.com/martynsmith/node-irc/pull/43) ([Excedrin](https://github.com/Excedrin))
423
+- Fixed missing nick in TOPIC socketio event [\#41](https://github.com/martynsmith/node-irc/pull/41) ([alexmingoia](https://github.com/alexmingoia))
424
+- Document internal functions and variables, activateFloodProtection [\#37](https://github.com/martynsmith/node-irc/pull/37) ([Hello71](https://github.com/Hello71))
425
+- first pass at sphinx docs [\#35](https://github.com/martynsmith/node-irc/pull/35) ([wraithan](https://github.com/wraithan))
426
+- adding colors [\#33](https://github.com/martynsmith/node-irc/pull/33) ([wraithan](https://github.com/wraithan))
427
+- split out irc codes from client code. [\#31](https://github.com/martynsmith/node-irc/pull/31) ([wraithan](https://github.com/wraithan))
428
+
429
+## [v0.2.1](https://github.com/martynsmith/node-irc/tree/v0.2.1) (2011-10-01)
430
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.2.0...v0.2.1)
431
+
432
+**Closed issues:**
433
+
434
+- \[Path [\#22](https://github.com/martynsmith/node-irc/issues/22)
435
+- Should sending messages also emit a 'message' signal? [\#17](https://github.com/martynsmith/node-irc/issues/17)
436
+- provide a way to access the current nick [\#12](https://github.com/martynsmith/node-irc/issues/12)
437
+
438
+**Merged pull requests:**
439
+
440
+- Self signed SSL certificates [\#27](https://github.com/martynsmith/node-irc/pull/27) ([stigi](https://github.com/stigi))
441
+- Adds 'selfMessage' event [\#25](https://github.com/martynsmith/node-irc/pull/25) ([AvianFlu](https://github.com/AvianFlu))
442
+- Added support for flood protection [\#23](https://github.com/martynsmith/node-irc/pull/23) ([epeli](https://github.com/epeli))
443
+- Fixed bug when sending empty strings or several lines to say [\#21](https://github.com/martynsmith/node-irc/pull/21) ([eirikb](https://github.com/eirikb))
444
+- append notice method to Client.prototype. [\#20](https://github.com/martynsmith/node-irc/pull/20) ([futoase](https://github.com/futoase))
445
+- Parsing out ~ & and % in the channel user list [\#15](https://github.com/martynsmith/node-irc/pull/15) ([pusherman](https://github.com/pusherman))
446
+- Reconnect all rooms upon server reconnect.   [\#14](https://github.com/martynsmith/node-irc/pull/14) ([lloyd](https://github.com/lloyd))
447
+- listen for the socket 'close' event rather than 'end'.  'end' is triggere [\#13](https://github.com/martynsmith/node-irc/pull/13) ([lloyd](https://github.com/lloyd))
448
+- Bug fix in join/part/kick events [\#11](https://github.com/martynsmith/node-irc/pull/11) ([luscoma](https://github.com/luscoma))
449
+
450
+## [v0.2.0](https://github.com/martynsmith/node-irc/tree/v0.2.0) (2011-04-29)
451
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.1.2...v0.2.0)
452
+
453
+**Merged pull requests:**
454
+
455
+- Add an event for `/invite` [\#10](https://github.com/martynsmith/node-irc/pull/10) ([jsocol](https://github.com/jsocol))
456
+- Documented the Client.Disconnect method [\#9](https://github.com/martynsmith/node-irc/pull/9) ([mdwrigh2](https://github.com/mdwrigh2))
457
+- Updated ssl support to work with tsl [\#8](https://github.com/martynsmith/node-irc/pull/8) ([indiefan](https://github.com/indiefan))
458
+- QUIT and NICK events [\#7](https://github.com/martynsmith/node-irc/pull/7) ([Mortal](https://github.com/Mortal))
459
+- autoConnect Client option [\#6](https://github.com/martynsmith/node-irc/pull/6) ([Oshuma](https://github.com/Oshuma))
460
+- added a "notice" event [\#5](https://github.com/martynsmith/node-irc/pull/5) ([thejh](https://github.com/thejh))
461
+- Properly handle changing user mode [\#4](https://github.com/martynsmith/node-irc/pull/4) ([justinabrahms](https://github.com/justinabrahms))
462
+- fix unwritable stream error after disconnected [\#3](https://github.com/martynsmith/node-irc/pull/3) ([sublee](https://github.com/sublee))
463
+
464
+## [v0.1.2](https://github.com/martynsmith/node-irc/tree/v0.1.2) (2010-05-19)
465
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.1.1...v0.1.2)
466
+
467
+## [v0.1.1](https://github.com/martynsmith/node-irc/tree/v0.1.1) (2010-05-15)
468
+[Full Changelog](https://github.com/martynsmith/node-irc/compare/v0.1.0...v0.1.1)
469
+
470
+## [v0.1.0](https://github.com/martynsmith/node-irc/tree/v0.1.0) (2010-05-14)
471
+
472
+
473
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
0 474
\ No newline at end of file
... ...
@@ -0,0 +1,47 @@
1
+# Contributing to node-irc
2
+
3
+First, and most importantly, thank you for contributing to node-irc! Your efforts make the library
4
+as awesome as it is, and we really couldn't do it without you. Through your pull requests, issues,
5
+and discussion, together we are building the best IRC library for node. So, once again, *thank you*!
6
+
7
+What follows is a set of guidelines for contributing to node-irc. We ask that you follow them
8
+because they make our lives as maintainers easier, which means that your pull requests and issues
9
+have a higher chance of being addressed quickly. Please help us help you!
10
+
11
+This guide is roughly based on the [Atom contributor's guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md), so thanks to the Atom team for
12
+providing such a solid framework on which to hang our ideas.
13
+
14
+# Submitting Issues
15
+* Include the version of node-irc, or the SHA1 from git if you're using git.
16
+* Include the behavior you expect, other clients / bots where you've seen that behavior, the
17
+ observed behavior, and details on how the two differ if it's not obvious.
18
+* Enable debug mode for node-irc and include its output in your report.
19
+* In the case of a crash, include the full stack trace and any error output.
20
+* Perform a cursory search to see if similar issues or pull requests have already been filed, and
21
+comment on them to move the discussion forward.
22
+* Most importantly, provide a minimal test case that demonstrates your bug. This is the best way
23
+to help us quickly isolate and fix your bug.
24
+* Consider joining us on IRC (##node-irc on freenode) for realtime discussion. Not only is it a
25
+friendly gesture, it also helps us isolate your issue far more quickly than the back-and-forth of
26
+issues on github allows.
27
+
28
+# Pull requests
29
+* Add yourself to the contributors section of package.json to claim credit for your work!
30
+* Do your work on a branch from master and file your pull request from that branch to master.
31
+* Make sure your code passes all tests (`npm run test; npm run lint`).
32
+* If possible, write *new* tests for the functionality you add. Once we have sane testing in place,
33
+this will become a hard requirement, so it's best to get used to it now!
34
+* If you change any user-facing element of the library (e.g. the API), document your changes.
35
+* If you make *breaking* changes, say so clearly in your pull request, so we know to schedule the
36
+merge when we plan to break the API for other changes.
37
+* Squash your commits into one before issuing your pull request. If you are not sure how to do this,
38
+take a look at the [edx instructions](https://github.com/edx/edx-platform/wiki/How-to-Rebase-a-Pull-Request) and change the
39
+obvious things to apply to your node-irc fork. If this doesn't make sense, or you're having trouble,
40
+come talk to us on IRC! We'll be glad to walk you through it.
41
+* End files with a newline.
42
+
43
+# Commit messages
44
+* Use the present tense ("Add feature" not "Added feature").
45
+* Use the imperative mood ("Change message handling..." not "Changes message handling...").
46
+* Limit the first line to 72 characters or less.
47
+* Reference issues and pull requests liberally.
... ...
@@ -0,0 +1,674 @@
1
+                    GNU GENERAL PUBLIC LICENSE
2
+                       Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+                            Preamble
9
+
10
+  The GNU General Public License is a free, copyleft license for
11
+software and other kinds of works.
12
+
13
+  The licenses for most software and other practical works are designed
14
+to take away your freedom to share and change the works.  By contrast,
15
+the GNU General Public License is intended to guarantee your freedom to
16
+share and change all versions of a program--to make sure it remains free
17
+software for all its users.  We, the Free Software Foundation, use the
18
+GNU General Public License for most of our software; it applies also to
19
+any other work released this way by its authors.  You can apply it to
20
+your programs, too.
21
+
22
+  When we speak of free software, we are referring to freedom, not
23
+price.  Our General Public Licenses are designed to make sure that you
24
+have the freedom to distribute copies of free software (and charge for
25
+them if you wish), that you receive source code or can get it if you
26
+want it, that you can change the software or use pieces of it in new
27
+free programs, and that you know you can do these things.
28
+
29
+  To protect your rights, we need to prevent others from denying you
30
+these rights or asking you to surrender the rights.  Therefore, you have
31
+certain responsibilities if you distribute copies of the software, or if
32
+you modify it: responsibilities to respect the freedom of others.
33
+
34
+  For example, if you distribute copies of such a program, whether
35
+gratis or for a fee, you must pass on to the recipients the same
36
+freedoms that you received.  You must make sure that they, too, receive
37
+or can get the source code.  And you must show them these terms so they
38
+know their rights.
39
+
40
+  Developers that use the GNU GPL protect your rights with two steps:
41
+(1) assert copyright on the software, and (2) offer you this License
42
+giving you legal permission to copy, distribute and/or modify it.
43
+
44
+  For the developers' and authors' protection, the GPL clearly explains
45
+that there is no warranty for this free software.  For both users' and
46
+authors' sake, the GPL requires that modified versions be marked as
47
+changed, so that their problems will not be attributed erroneously to
48
+authors of previous versions.
49
+
50
+  Some devices are designed to deny users access to install or run
51
+modified versions of the software inside them, although the manufacturer
52
+can do so.  This is fundamentally incompatible with the aim of
53
+protecting users' freedom to change the software.  The systematic
54
+pattern of such abuse occurs in the area of products for individuals to
55
+use, which is precisely where it is most unacceptable.  Therefore, we
56
+have designed this version of the GPL to prohibit the practice for those
57
+products.  If such problems arise substantially in other domains, we
58
+stand ready to extend this provision to those domains in future versions
59
+of the GPL, as needed to protect the freedom of users.
60
+
61
+  Finally, every program is threatened constantly by software patents.
62
+States should not allow patents to restrict development and use of
63
+software on general-purpose computers, but in those that do, we wish to
64
+avoid the special danger that patents applied to a free program could
65
+make it effectively proprietary.  To prevent this, the GPL assures that
66
+patents cannot be used to render the program non-free.
67
+
68
+  The precise terms and conditions for copying, distribution and
69
+modification follow.
70
+
71
+                       TERMS AND CONDITIONS
72
+
73
+  0. Definitions.
74
+
75
+  "This License" refers to version 3 of the GNU General Public License.
76
+
77
+  "Copyright" also means copyright-like laws that apply to other kinds of
78
+works, such as semiconductor masks.
79
+
80
+  "The Program" refers to any copyrightable work licensed under this
81
+License.  Each licensee is addressed as "you".  "Licensees" and
82
+"recipients" may be individuals or organizations.
83
+
84
+  To "modify" a work means to copy from or adapt all or part of the work
85
+in a fashion requiring copyright permission, other than the making of an
86
+exact copy.  The resulting work is called a "modified version" of the
87
+earlier work or a work "based on" the earlier work.
88
+
89
+  A "covered work" means either the unmodified Program or a work based
90
+on the Program.
91
+
92
+  To "propagate" a work means to do anything with it that, without
93
+permission, would make you directly or secondarily liable for
94
+infringement under applicable copyright law, except executing it on a
95
+computer or modifying a private copy.  Propagation includes copying,
96
+distribution (with or without modification), making available to the
97
+public, and in some countries other activities as well.
98
+
99
+  To "convey" a work means any kind of propagation that enables other
100
+parties to make or receive copies.  Mere interaction with a user through
101
+a computer network, with no transfer of a copy, is not conveying.
102
+
103
+  An interactive user interface displays "Appropriate Legal Notices"
104
+to the extent that it includes a convenient and prominently visible
105
+feature that (1) displays an appropriate copyright notice, and (2)
106
+tells the user that there is no warranty for the work (except to the
107
+extent that warranties are provided), that licensees may convey the
108
+work under this License, and how to view a copy of this License.  If
109
+the interface presents a list of user commands or options, such as a
110
+menu, a prominent item in the list meets this criterion.
111
+
112
+  1. Source Code.
113
+
114
+  The "source code" for a work means the preferred form of the work
115
+for making modifications to it.  "Object code" means any non-source
116
+form of a work.
117
+
118
+  A "Standard Interface" means an interface that either is an official
119
+standard defined by a recognized standards body, or, in the case of
120
+interfaces specified for a particular programming language, one that
121
+is widely used among developers working in that language.
122
+
123
+  The "System Libraries" of an executable work include anything, other
124
+than the work as a whole, that (a) is included in the normal form of
125
+packaging a Major Component, but which is not part of that Major
126
+Component, and (b) serves only to enable use of the work with that
127
+Major Component, or to implement a Standard Interface for which an
128
+implementation is available to the public in source code form.  A
129
+"Major Component", in this context, means a major essential component
130
+(kernel, window system, and so on) of the specific operating system
131
+(if any) on which the executable work runs, or a compiler used to
132
+produce the work, or an object code interpreter used to run it.
133
+
134
+  The "Corresponding Source" for a work in object code form means all
135
+the source code needed to generate, install, and (for an executable
136
+work) run the object code and to modify the work, including scripts to
137
+control those activities.  However, it does not include the work's
138
+System Libraries, or general-purpose tools or generally available free
139
+programs which are used unmodified in performing those activities but
140
+which are not part of the work.  For example, Corresponding Source
141
+includes interface definition files associated with source files for
142
+the work, and the source code for shared libraries and dynamically
143
+linked subprograms that the work is specifically designed to require,
144
+such as by intimate data communication or control flow between those
145
+subprograms and other parts of the work.
146
+
147
+  The Corresponding Source need not include anything that users
148
+can regenerate automatically from other parts of the Corresponding
149
+Source.
150
+
151
+  The Corresponding Source for a work in source code form is that
152
+same work.
153
+
154
+  2. Basic Permissions.
155
+
156
+  All rights granted under this License are granted for the term of
157
+copyright on the Program, and are irrevocable provided the stated
158
+conditions are met.  This License explicitly affirms your unlimited
159
+permission to run the unmodified Program.  The output from running a
160
+covered work is covered by this License only if the output, given its
161
+content, constitutes a covered work.  This License acknowledges your
162
+rights of fair use or other equivalent, as provided by copyright law.
163
+
164
+  You may make, run and propagate covered works that you do not
165
+convey, without conditions so long as your license otherwise remains
166
+in force.  You may convey covered works to others for the sole purpose
167
+of having them make modifications exclusively for you, or provide you
168
+with facilities for running those works, provided that you comply with
169
+the terms of this License in conveying all material for which you do
170
+not control copyright.  Those thus making or running the covered works
171
+for you must do so exclusively on your behalf, under your direction
172
+and control, on terms that prohibit them from making any copies of
173
+your copyrighted material outside their relationship with you.
174
+
175
+  Conveying under any other circumstances is permitted solely under
176
+the conditions stated below.  Sublicensing is not allowed; section 10
177
+makes it unnecessary.
178
+
179
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
+
181
+  No covered work shall be deemed part of an effective technological
182
+measure under any applicable law fulfilling obligations under article
183
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
+similar laws prohibiting or restricting circumvention of such
185
+measures.
186
+
187
+  When you convey a covered work, you waive any legal power to forbid
188
+circumvention of technological measures to the extent such circumvention
189
+is effected by exercising rights under this License with respect to
190
+the covered work, and you disclaim any intention to limit operation or
191
+modification of the work as a means of enforcing, against the work's
192
+users, your or third parties' legal rights to forbid circumvention of
193
+technological measures.
194
+
195
+  4. Conveying Verbatim Copies.
196
+
197
+  You may convey verbatim copies of the Program's source code as you
198
+receive it, in any medium, provided that you conspicuously and
199
+appropriately publish on each copy an appropriate copyright notice;
200
+keep intact all notices stating that this License and any
201
+non-permissive terms added in accord with section 7 apply to the code;
202
+keep intact all notices of the absence of any warranty; and give all
203
+recipients a copy of this License along with the Program.
204
+
205
+  You may charge any price or no price for each copy that you convey,
206
+and you may offer support or warranty protection for a fee.
207
+
208
+  5. Conveying Modified Source Versions.
209
+
210
+  You may convey a work based on the Program, or the modifications to
211
+produce it from the Program, in the form of source code under the
212
+terms of section 4, provided that you also meet all of these conditions:
213
+
214
+    a) The work must carry prominent notices stating that you modified
215
+    it, and giving a relevant date.
216
+
217
+    b) The work must carry prominent notices stating that it is
218
+    released under this License and any conditions added under section
219
+    7.  This requirement modifies the requirement in section 4 to
220
+    "keep intact all notices".
221
+
222
+    c) You must license the entire work, as a whole, under this
223
+    License to anyone who comes into possession of a copy.  This
224
+    License will therefore apply, along with any applicable section 7
225
+    additional terms, to the whole of the work, and all its parts,
226
+    regardless of how they are packaged.  This License gives no
227
+    permission to license the work in any other way, but it does not
228
+    invalidate such permission if you have separately received it.
229
+
230
+    d) If the work has interactive user interfaces, each must display
231
+    Appropriate Legal Notices; however, if the Program has interactive
232
+    interfaces that do not display Appropriate Legal Notices, your
233
+    work need not make them do so.
234
+
235
+  A compilation of a covered work with other separate and independent
236
+works, which are not by their nature extensions of the covered work,
237
+and which are not combined with it such as to form a larger program,
238
+in or on a volume of a storage or distribution medium, is called an
239
+"aggregate" if the compilation and its resulting copyright are not
240
+used to limit the access or legal rights of the compilation's users
241
+beyond what the individual works permit.  Inclusion of a covered work
242
+in an aggregate does not cause this License to apply to the other
243
+parts of the aggregate.
244
+
245
+  6. Conveying Non-Source Forms.
246
+
247
+  You may convey a covered work in object code form under the terms
248
+of sections 4 and 5, provided that you also convey the
249
+machine-readable Corresponding Source under the terms of this License,
250
+in one of these ways:
251
+
252
+    a) Convey the object code in, or embodied in, a physical product
253
+    (including a physical distribution medium), accompanied by the
254
+    Corresponding Source fixed on a durable physical medium
255
+    customarily used for software interchange.
256
+
257
+    b) Convey the object code in, or embodied in, a physical product
258
+    (including a physical distribution medium), accompanied by a
259
+    written offer, valid for at least three years and valid for as
260
+    long as you offer spare parts or customer support for that product
261
+    model, to give anyone who possesses the object code either (1) a
262
+    copy of the Corresponding Source for all the software in the
263
+    product that is covered by this License, on a durable physical
264
+    medium customarily used for software interchange, for a price no
265
+    more than your reasonable cost of physically performing this
266
+    conveying of source, or (2) access to copy the
267
+    Corresponding Source from a network server at no charge.
268
+
269
+    c) Convey individual copies of the object code with a copy of the
270
+    written offer to provide the Corresponding Source.  This
271
+    alternative is allowed only occasionally and noncommercially, and
272
+    only if you received the object code with such an offer, in accord
273
+    with subsection 6b.
274
+
275
+    d) Convey the object code by offering access from a designated
276
+    place (gratis or for a charge), and offer equivalent access to the
277
+    Corresponding Source in the same way through the same place at no
278
+    further charge.  You need not require recipients to copy the
279
+    Corresponding Source along with the object code.  If the place to
280
+    copy the object code is a network server, the Corresponding Source
281
+    may be on a different server (operated by you or a third party)
282
+    that supports equivalent copying facilities, provided you maintain
283
+    clear directions next to the object code saying where to find the
284
+    Corresponding Source.  Regardless of what server hosts the
285
+    Corresponding Source, you remain obligated to ensure that it is
286
+    available for as long as needed to satisfy these requirements.
287
+
288
+    e) Convey the object code using peer-to-peer transmission, provided
289
+    you inform other peers where the object code and Corresponding
290
+    Source of the work are being offered to the general public at no
291
+    charge under subsection 6d.
292
+
293
+  A separable portion of the object code, whose source code is excluded
294
+from the Corresponding Source as a System Library, need not be
295
+included in conveying the object code work.
296
+
297
+  A "User Product" is either (1) a "consumer product", which means any
298
+tangible personal property which is normally used for personal, family,
299
+or household purposes, or (2) anything designed or sold for incorporation
300
+into a dwelling.  In determining whether a product is a consumer product,
301
+doubtful cases shall be resolved in favor of coverage.  For a particular
302
+product received by a particular user, "normally used" refers to a
303
+typical or common use of that class of product, regardless of the status
304
+of the particular user or of the way in which the particular user
305
+actually uses, or expects or is expected to use, the product.  A product
306
+is a consumer product regardless of whether the product has substantial
307
+commercial, industrial or non-consumer uses, unless such uses represent
308
+the only significant mode of use of the product.
309
+
310
+  "Installation Information" for a User Product means any methods,
311
+procedures, authorization keys, or other information required to install
312
+and execute modified versions of a covered work in that User Product from
313
+a modified version of its Corresponding Source.  The information must
314
+suffice to ensure that the continued functioning of the modified object
315
+code is in no case prevented or interfered with solely because
316
+modification has been made.
317
+
318
+  If you convey an object code work under this section in, or with, or
319
+specifically for use in, a User Product, and the conveying occurs as
320
+part of a transaction in which the right of possession and use of the
321
+User Product is transferred to the recipient in perpetuity or for a
322
+fixed term (regardless of how the transaction is characterized), the
323
+Corresponding Source conveyed under this section must be accompanied
324
+by the Installation Information.  But this requirement does not apply
325
+if neither you nor any third party retains the ability to install
326
+modified object code on the User Product (for example, the work has
327
+been installed in ROM).
328
+
329
+  The requirement to provide Installation Information does not include a
330
+requirement to continue to provide support service, warranty, or updates
331
+for a work that has been modified or installed by the recipient, or for
332
+the User Product in which it has been modified or installed.  Access to a
333
+network may be denied when the modification itself materially and
334
+adversely affects the operation of the network or violates the rules and
335
+protocols for communication across the network.
336
+
337
+  Corresponding Source conveyed, and Installation Information provided,
338
+in accord with this section must be in a format that is publicly
339
+documented (and with an implementation available to the public in
340
+source code form), and must require no special password or key for
341
+unpacking, reading or copying.
342
+
343
+  7. Additional Terms.
344
+
345
+  "Additional permissions" are terms that supplement the terms of this
346
+License by making exceptions from one or more of its conditions.
347
+Additional permissions that are applicable to the entire Program shall
348
+be treated as though they were included in this License, to the extent
349
+that they are valid under applicable law.  If additional permissions
350
+apply only to part of the Program, that part may be used separately
351
+under those permissions, but the entire Program remains governed by
352
+this License without regard to the additional permissions.
353
+
354
+  When you convey a copy of a covered work, you may at your option
355
+remove any additional permissions from that copy, or from any part of
356
+it.  (Additional permissions may be written to require their own
357
+removal in certain cases when you modify the work.)  You may place
358
+additional permissions on material, added by you to a covered work,
359
+for which you have or can give appropriate copyright permission.
360
+
361
+  Notwithstanding any other provision of this License, for material you
362
+add to a covered work, you may (if authorized by the copyright holders of
363
+that material) supplement the terms of this License with terms:
364
+
365
+    a) Disclaiming warranty or limiting liability differently from the
366
+    terms of sections 15 and 16 of this License; or
367
+
368
+    b) Requiring preservation of specified reasonable legal notices or
369
+    author attributions in that material or in the Appropriate Legal
370
+    Notices displayed by works containing it; or
371
+
372
+    c) Prohibiting misrepresentation of the origin of that material, or
373
+    requiring that modified versions of such material be marked in
374
+    reasonable ways as different from the original version; or
375
+
376
+    d) Limiting the use for publicity purposes of names of licensors or
377
+    authors of the material; or
378
+
379
+    e) Declining to grant rights under trademark law for use of some
380
+    trade names, trademarks, or service marks; or
381
+
382
+    f) Requiring indemnification of licensors and authors of that
383
+    material by anyone who conveys the material (or modified versions of
384
+    it) with contractual assumptions of liability to the recipient, for
385
+    any liability that these contractual assumptions directly impose on
386
+    those licensors and authors.
387
+
388
+  All other non-permissive additional terms are considered "further
389
+restrictions" within the meaning of section 10.  If the Program as you
390
+received it, or any part of it, contains a notice stating that it is
391
+governed by this License along with a term that is a further
392
+restriction, you may remove that term.  If a license document contains
393
+a further restriction but permits relicensing or conveying under this
394
+License, you may add to a covered work material governed by the terms
395
+of that license document, provided that the further restriction does
396
+not survive such relicensing or conveying.
397
+
398
+  If you add terms to a covered work in accord with this section, you
399
+must place, in the relevant source files, a statement of the
400
+additional terms that apply to those files, or a notice indicating
401
+where to find the applicable terms.
402
+
403
+  Additional terms, permissive or non-permissive, may be stated in the
404
+form of a separately written license, or stated as exceptions;
405
+the above requirements apply either way.
406
+
407
+  8. Termination.
408
+
409
+  You may not propagate or modify a covered work except as expressly
410
+provided under this License.  Any attempt otherwise to propagate or
411
+modify it is void, and will automatically terminate your rights under
412
+this License (including any patent licenses granted under the third
413
+paragraph of section 11).
414
+
415
+  However, if you cease all violation of this License, then your
416
+license from a particular copyright holder is reinstated (a)
417
+provisionally, unless and until the copyright holder explicitly and
418
+finally terminates your license, and (b) permanently, if the copyright
419
+holder fails to notify you of the violation by some reasonable means
420
+prior to 60 days after the cessation.
421
+
422
+  Moreover, your license from a particular copyright holder is
423
+reinstated permanently if the copyright holder notifies you of the
424
+violation by some reasonable means, this is the first time you have
425
+received notice of violation of this License (for any work) from that
426
+copyright holder, and you cure the violation prior to 30 days after
427
+your receipt of the notice.
428
+
429
+  Termination of your rights under this section does not terminate the
430
+licenses of parties who have received copies or rights from you under
431
+this License.  If your rights have been terminated and not permanently
432
+reinstated, you do not qualify to receive new licenses for the same
433
+material under section 10.
434
+
435
+  9. Acceptance Not Required for Having Copies.
436
+
437
+  You are not required to accept this License in order to receive or
438
+run a copy of the Program.  Ancillary propagation of a covered work
439
+occurring solely as a consequence of using peer-to-peer transmission
440
+to receive a copy likewise does not require acceptance.  However,
441
+nothing other than this License grants you permission to propagate or
442
+modify any covered work.  These actions infringe copyright if you do
443
+not accept this License.  Therefore, by modifying or propagating a
444
+covered work, you indicate your acceptance of this License to do so.
445
+
446
+  10. Automatic Licensing of Downstream Recipients.
447
+
448
+  Each time you convey a covered work, the recipient automatically
449
+receives a license from the original licensors, to run, modify and
450
+propagate that work, subject to this License.  You are not responsible
451
+for enforcing compliance by third parties with this License.
452
+
453
+  An "entity transaction" is a transaction transferring control of an
454
+organization, or substantially all assets of one, or subdividing an
455
+organization, or merging organizations.  If propagation of a covered
456
+work results from an entity transaction, each party to that
457
+transaction who receives a copy of the work also receives whatever
458
+licenses to the work the party's predecessor in interest had or could
459
+give under the previous paragraph, plus a right to possession of the
460
+Corresponding Source of the work from the predecessor in interest, if
461
+the predecessor has it or can get it with reasonable efforts.
462
+
463
+  You may not impose any further restrictions on the exercise of the
464
+rights granted or affirmed under this License.  For example, you may
465
+not impose a license fee, royalty, or other charge for exercise of
466
+rights granted under this License, and you may not initiate litigation
467
+(including a cross-claim or counterclaim in a lawsuit) alleging that
468
+any patent claim is infringed by making, using, selling, offering for
469
+sale, or importing the Program or any portion of it.
470
+
471
+  11. Patents.
472
+
473
+  A "contributor" is a copyright holder who authorizes use under this
474
+License of the Program or a work on which the Program is based.  The
475
+work thus licensed is called the contributor's "contributor version".
476
+
477
+  A contributor's "essential patent claims" are all patent claims
478
+owned or controlled by the contributor, whether already acquired or
479
+hereafter acquired, that would be infringed by some manner, permitted
480
+by this License, of making, using, or selling its contributor version,
481
+but do not include claims that would be infringed only as a
482
+consequence of further modification of the contributor version.  For
483
+purposes of this definition, "control" includes the right to grant
484
+patent sublicenses in a manner consistent with the requirements of
485
+this License.
486
+
487
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
488
+patent license under the contributor's essential patent claims, to
489
+make, use, sell, offer for sale, import and otherwise run, modify and
490
+propagate the contents of its contributor version.
491
+
492
+  In the following three paragraphs, a "patent license" is any express
493
+agreement or commitment, however denominated, not to enforce a patent
494
+(such as an express permission to practice a patent or covenant not to
495
+sue for patent infringement).  To "grant" such a patent license to a
496
+party means to make such an agreement or commitment not to enforce a
497
+patent against the party.
498
+
499
+  If you convey a covered work, knowingly relying on a patent license,
500
+and the Corresponding Source of the work is not available for anyone
501
+to copy, free of charge and under the terms of this License, through a
502
+publicly available network server or other readily accessible means,
503
+then you must either (1) cause the Corresponding Source to be so
504
+available, or (2) arrange to deprive yourself of the benefit of the
505
+patent license for this particular work, or (3) arrange, in a manner
506
+consistent with the requirements of this License, to extend the patent
507
+license to downstream recipients.  "Knowingly relying" means you have
508
+actual knowledge that, but for the patent license, your conveying the
509
+covered work in a country, or your recipient's use of the covered work
510
+in a country, would infringe one or more identifiable patents in that
511
+country that you have reason to believe are valid.
512
+
513
+  If, pursuant to or in connection with a single transaction or
514
+arrangement, you convey, or propagate by procuring conveyance of, a
515
+covered work, and grant a patent license to some of the parties
516
+receiving the covered work authorizing them to use, propagate, modify
517
+or convey a specific copy of the covered work, then the patent license
518
+you grant is automatically extended to all recipients of the covered
519
+work and works based on it.
520
+
521
+  A patent license is "discriminatory" if it does not include within
522
+the scope of its coverage, prohibits the exercise of, or is
523
+conditioned on the non-exercise of one or more of the rights that are
524
+specifically granted under this License.  You may not convey a covered
525
+work if you are a party to an arrangement with a third party that is
526
+in the business of distributing software, under which you make payment
527
+to the third party based on the extent of your activity of conveying
528
+the work, and under which the third party grants, to any of the
529
+parties who would receive the covered work from you, a discriminatory
530
+patent license (a) in connection with copies of the covered work
531
+conveyed by you (or copies made from those copies), or (b) primarily
532
+for and in connection with specific products or compilations that
533
+contain the covered work, unless you entered into that arrangement,
534
+or that patent license was granted, prior to 28 March 2007.
535
+
536
+  Nothing in this License shall be construed as excluding or limiting
537
+any implied license or other defenses to infringement that may
538
+otherwise be available to you under applicable patent law.
539
+
540
+  12. No Surrender of Others' Freedom.
541
+
542
+  If conditions are imposed on you (whether by court order, agreement or
543
+otherwise) that contradict the conditions of this License, they do not
544
+excuse you from the conditions of this License.  If you cannot convey a
545
+covered work so as to satisfy simultaneously your obligations under this
546
+License and any other pertinent obligations, then as a consequence you may
547
+not convey it at all.  For example, if you agree to terms that obligate you
548
+to collect a royalty for further conveying from those to whom you convey
549
+the Program, the only way you could satisfy both those terms and this
550
+License would be to refrain entirely from conveying the Program.
551
+
552
+  13. Use with the GNU Affero General Public License.
553
+
554
+  Notwithstanding any other provision of this License, you have
555
+permission to link or combine any covered work with a work licensed
556
+under version 3 of the GNU Affero General Public License into a single
557
+combined work, and to convey the resulting work.  The terms of this
558
+License will continue to apply to the part which is the covered work,
559
+but the special requirements of the GNU Affero General Public License,
560
+section 13, concerning interaction through a network will apply to the
561
+combination as such.
562
+
563
+  14. Revised Versions of this License.
564
+
565
+  The Free Software Foundation may publish revised and/or new versions of
566
+the GNU General Public License from time to time.  Such new versions will
567
+be similar in spirit to the present version, but may differ in detail to
568
+address new problems or concerns.
569
+
570
+  Each version is given a distinguishing version number.  If the
571
+Program specifies that a certain numbered version of the GNU General
572
+Public License "or any later version" applies to it, you have the
573
+option of following the terms and conditions either of that numbered
574
+version or of any later version published by the Free Software
575
+Foundation.  If the Program does not specify a version number of the
576
+GNU General Public License, you may choose any version ever published
577
+by the Free Software Foundation.
578
+
579
+  If the Program specifies that a proxy can decide which future
580
+versions of the GNU General Public License can be used, that proxy's
581
+public statement of acceptance of a version permanently authorizes you
582
+to choose that version for the Program.
583
+
584
+  Later license versions may give you additional or different
585
+permissions.  However, no additional obligations are imposed on any
586
+author or copyright holder as a result of your choosing to follow a
587
+later version.
588
+
589
+  15. Disclaimer of Warranty.
590
+
591
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
+
600
+  16. Limitation of Liability.
601
+
602
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
+SUCH DAMAGES.
611
+
612
+  17. Interpretation of Sections 15 and 16.
613
+
614
+  If the disclaimer of warranty and limitation of liability provided
615
+above cannot be given local legal effect according to their terms,
616
+reviewing courts shall apply local law that most closely approximates
617
+an absolute waiver of all civil liability in connection with the
618
+Program, unless a warranty or assumption of liability accompanies a
619
+copy of the Program in return for a fee.
620
+
621
+                     END OF TERMS AND CONDITIONS
622
+
623
+            How to Apply These Terms to Your New Programs
624
+
625
+  If you develop a new program, and you want it to be of the greatest
626
+possible use to the public, the best way to achieve this is to make it
627
+free software which everyone can redistribute and change under these terms.
628
+
629
+  To do so, attach the following notices to the program.  It is safest
630
+to attach them to the start of each source file to most effectively
631
+state the exclusion of warranty; and each file should have at least
632
+the "copyright" line and a pointer to where the full notice is found.
633
+
634
+    <one line to give the program's name and a brief idea of what it does.>
635
+    Copyright (C) <year>  <name of author>
636
+
637
+    This program is free software: you can redistribute it and/or modify
638
+    it under the terms of the GNU General Public License as published by
639
+    the Free Software Foundation, either version 3 of the License, or
640
+    (at your option) any later version.
641
+
642
+    This program is distributed in the hope that it will be useful,
643
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
644
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645
+    GNU General Public License for more details.
646
+
647
+    You should have received a copy of the GNU General Public License
648
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
649
+
650
+Also add information on how to contact you by electronic and paper mail.
651
+
652
+  If the program does terminal interaction, make it output a short
653
+notice like this when it starts in an interactive mode:
654
+
655
+    <program>  Copyright (C) <year>  <name of author>
656
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
+    This is free software, and you are welcome to redistribute it
658
+    under certain conditions; type `show c' for details.
659
+
660
+The hypothetical commands `show w' and `show c' should show the appropriate
661
+parts of the General Public License.  Of course, your program's commands
662
+might be different; for a GUI interface, you would use an "about box".
663
+
664
+  You should also get your employer (if you work as a programmer) or school,
665
+if any, to sign a "copyright disclaimer" for the program, if necessary.
666
+For more information on this, and how to apply and follow the GNU GPL, see
667
+<http://www.gnu.org/licenses/>.
668
+
669
+  The GNU General Public License does not permit incorporating your program
670
+into proprietary programs.  If your program is a subroutine library, you
671
+may consider it more useful to permit linking proprietary applications with
672
+the library.  If this is what you want to do, use the GNU Lesser General
673
+Public License instead of this License.  But first, please read
674
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
... ...
@@ -0,0 +1,134 @@
1
+[![Travis](https://img.shields.io/travis/martynsmith/node-irc.svg?style=flat)](https://travis-ci.org/martynsmith/node-irc)
2
+[![npm](https://img.shields.io/npm/v/irc.svg?style=flat)](https://www.npmjs.com/package/irc)
3
+[![Dependency Status](https://img.shields.io/david/martynsmith/node-irc.svg?style=flat)](https://david-dm.org/martynsmith/node-irc#info=Dependencies)
4
+[![devDependency Status](https://img.shields.io/david/dev/martynsmith/node-irc.svg?style=flat)](https://david-dm.org/martynsmith/node-irc#info=devDependencies)
5
+[![License](https://img.shields.io/badge/license-GPLv3-blue.svg?style=flat)](http://opensource.org/licenses/GPL-3.0)
6
+[![Join the chat at https://gitter.im/martynsmith/node-irc](https://badges.gitter.im/martynsmith/node-irc.svg)](https://gitter.im/martynsmith/node-irc?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
7
+
8
+
9
+[node-irc](http://node-irc.readthedocs.org/) is an IRC client library written in [JavaScript](http://en.wikipedia.org/wiki/JavaScript) for [Node](http://nodejs.org/).
10
+
11
+You can access more detailed documentation for this module at [Read the Docs](http://readthedocs.org/docs/node-irc/en/latest/)
12
+
13
+
14
+## Installation
15
+
16
+The easiest way to get it is via [npm](http://github.com/isaacs/npm):
17
+
18
+```
19
+npm install irc
20
+```
21
+
22
+If you want to run the latest version (i.e. later than the version available via
23
+[npm](http://github.com/isaacs/npm)) you can clone this repo, then use [npm](http://github.com/isaacs/npm) to link-install it:
24
+
25
+```
26
+    npm link /path/to/your/clone
27
+```
28
+
29
+Of course, you can just clone this, and manually point at the library itself,
30
+but we really recommend using [npm](http://github.com/isaacs/npm)!
31
+
32
+Note that as of version 0.3.8, node-irc supports character set detection using
33
+[icu](http://site.icu-project.org/). You'll need to install libiconv (if
34
+necessary; Linux systems tend to ship this in their glibc) and libicu (and its
35
+headers, if necessary, [install instructions](https://github.com/mooz/node-icu-charset-detector#installing-icu)) in order to use this feature. If you do not have these
36
+libraries or their headers installed, you will receive errors when trying to
37
+build these dependencies. However, node-irc will still install (assuming
38
+nothing else failed) and you'll be able to use it, just not the character
39
+set features.
40
+
41
+## Basic Usage
42
+
43
+This library provides basic IRC client functionality. In the simplest case you
44
+can connect to an IRC server like so:
45
+
46
+```js
47
+var irc = require('irc');
48
+var client = new irc.Client('irc.yourserver.com', 'myNick', {
49
+    channels: ['#channel'],
50
+});
51
+```
52
+
53
+Of course it's not much use once it's connected if that's all you have!
54
+
55
+The client emits a large number of events that correlate to things you'd
56
+normally see in your favorite IRC client. Most likely the first one you'll want
57
+to use is:
58
+
59
+```js
60
+client.addListener('message', function (from, to, message) {
61
+    console.log(from + ' => ' + to + ': ' + message);
62
+});
63
+```
64
+
65
+or if you're only interested in messages to the bot itself:
66
+
67
+```js
68
+client.addListener('pm', function (from, message) {
69
+    console.log(from + ' => ME: ' + message);
70
+});
71
+```
72
+
73
+or to a particular channel:
74
+
75
+```js
76
+client.addListener('message#yourchannel', function (from, message) {
77
+    console.log(from + ' => #yourchannel: ' + message);
78
+});
79
+```
80
+
81
+At the moment there are functions for joining:
82
+
83
+```js
84
+client.join('#yourchannel yourpass');
85
+```
86
+
87
+parting:
88
+
89
+```js
90
+client.part('#yourchannel');
91
+```
92
+
93
+talking:
94
+
95
+```js
96
+client.say('#yourchannel', "I'm a bot!");
97
+client.say('nonbeliever', "SRSLY, I AM!");
98
+```
99
+
100
+and many others. Check out the API documentation for a complete reference.
101
+
102
+For any commands that there aren't methods for you can use the send() method
103
+which sends raw messages to the server:
104
+
105
+```js
106
+client.send('MODE', '#yourchannel', '+o', 'yournick');
107
+```
108
+
109
+## Help! - it keeps crashing!
110
+
111
+When the client receives errors from the IRC network, it emits an "error"
112
+event. As stated in the [Node JS EventEmitter documentation](http://nodejs.org/api/events.html#events_class_events_eventemitter) if you don't bind
113
+something to this error, it will cause a fatal stack trace.
114
+
115
+The upshot of this is basically that if you bind an error handler to your
116
+client, errors will be sent there instead of crashing your program.:
117
+
118
+```js
119
+client.addListener('error', function(message) {
120
+    console.log('error: ', message);
121
+});
122
+```
123
+
124
+
125
+## Further Support
126
+
127
+Further documentation (including a complete API reference) is available in
128
+reStructuredText format in the docs/ folder of this project, or online at [Read the Docs](http://readthedocs.org/docs/node-irc/en/latest/).
129
+
130
+If you find any issues with the documentation (or the module) please send a pull
131
+request or file an issue and we'll do our best to accommodate.
132
+
133
+You can also visit us on ##node-irc on freenode to discuss issues you're having
134
+with the library, pull requests, or anything else related to node-irc.
... ...
@@ -0,0 +1,548 @@
1
+API
2
+===
3
+
4
+This library provides IRC client functionality
5
+
6
+Client
7
+----------
8
+
9
+.. js:function:: irc.Client(server, nick [, options])
10
+
11
+    This object is the base of everything, it represents a single nick connected to
12
+    a single IRC server.
13
+
14
+    The first two arguments are the server to connect to, and the nickname to
15
+    attempt to use. The third optional argument is an options object with default
16
+    values::
17
+
18
+        {
19
+            userName: 'nodebot',
20
+            realName: 'nodeJS IRC client',
21
+            port: 6667,
22
+            localAddress: null,
23
+            debug: false,
24
+            showErrors: false,
25
+            autoRejoin: false,
26
+            autoConnect: true,
27
+            channels: [],
28
+            secure: false,
29
+            selfSigned: false,
30
+            certExpired: false,
31
+            floodProtection: false,
32
+            floodProtectionDelay: 1000,
33
+            sasl: false,
34
+            retryCount: 0,
35
+            retryDelay: 2000,
36
+            stripColors: false,
37
+            channelPrefixes: "&#",
38
+            messageSplit: 512,
39
+            encoding: ''
40
+        }
41
+
42
+    `secure` (SSL connection) can be a true value or an object (the kind of object
43
+    returned from `crypto.createCredentials()`) specifying cert etc for validation.
44
+    If you set `selfSigned` to true SSL accepts certificates from a non trusted CA.
45
+    If you set `certExpired` to true, the bot connects even if the ssl cert has expired.
46
+
47
+    `localAddress` is the address to bind to when connecting.
48
+
49
+    `floodProtection` queues all your messages and slowly unpacks it to make sure
50
+    that we won't get kicked out because for Excess Flood. You can also use
51
+    `Client.activateFloodProtection()` to activate flood protection after
52
+    instantiating the client.
53
+
54
+    `floodProtectionDelay` sets the amount of time that the client will wait
55
+    between sending subsequent messages when `floodProtection` is enabled.
56
+
57
+    Set `sasl` to true to enable SASL support. You'll also want to set `nick`,
58
+    `userName`, and `password` for authentication.
59
+
60
+    `stripColors` removes mirc colors (0x03 followed by one or two ascii
61
+    numbers for foreground,background) and ircII "effect" codes (0x02
62
+    bold, 0x1f underline, 0x16 reverse, 0x0f reset) from the entire
63
+    message before parsing it and passing it along.
64
+
65
+    `messageSplit` will split up large messages sent with the `say` method
66
+    into multiple messages of length fewer than `messageSplit` characters.
67
+
68
+    With `encoding` you can set IRC bot to convert all messages to specified character set. If you don't want to use
69
+    this just leave value blank or false. Example values are UTF-8, ISO-8859-15, etc.
70
+
71
+    Setting `debug` to true will emit timestamped messages to the console
72
+    using `util.log` when certain events are fired.
73
+
74
+    `autoRejoin` has the client rejoin channels after being kicked.
75
+
76
+    Setting `autoConnect` to false prevents the Client from connecting on
77
+    instantiation.  You will need to call `connect()` on the client instance::
78
+
79
+        var client = new irc.Client({ autoConnect: false, ... });
80
+        client.connect();
81
+
82
+    `retryCount` is the number of times the client will try to automatically reconnect when disconnected. It defaults to 0.
83
+
84
+    `retryDelay` is the number of milliseconds to wait before retying to automatically reconnect when disconnected. It defaults to 2000.
85
+
86
+.. js:function:: Client.send(command, arg1, arg2, ...)
87
+
88
+    Sends a raw message to the server; generally speaking, it's best not to use
89
+    this method unless you know what you're doing. Instead, use one of the
90
+    methods below.
91
+
92
+.. js:function:: Client.join(channel, callback)
93
+
94
+    Joins the specified channel.
95
+
96
+    :param string channel: Channel to join
97
+    :param function callback: Callback to automatically subscribed to the
98
+        `join#channel` event, but removed after the first invocation.  `channel`
99
+        supports multiple JOIN arguments as a space separated string (similar to
100
+        the IRC protocol).
101
+
102
+.. js:function:: Client.part(channel, [message], callback)
103
+
104
+    Parts the specified channel.
105
+
106
+    :param string channel: Channel to part
107
+    :param string message: Optional message to send upon leaving the channel
108
+    :param function callback: Callback to automatically subscribed to the
109
+        `part#channel` event, but removed after the first invocation.
110
+
111
+.. js:function:: Client.say(target, message)
112
+
113
+    Sends a message to the specified target.
114
+
115
+    :param string target: is either a nickname, or a channel.
116
+    :param string message: the message to send to the target.
117
+
118
+.. js:function:: Client.ctcp(target, type, text)
119
+
120
+    Sends a CTCP message to the specified target.
121
+
122
+    :param string target: is either a nickname, or a channel.
123
+    :param string type: the type of the CTCP message. Specify "privmsg" for a
124
+        PRIVMSG, and anything else for a NOTICE.
125
+    :param string text: the CTCP message to send.
126
+
127
+.. js:function:: Client.action(target, message)
128
+
129
+    Sends an action to the specified target.
130
+
131
+.. js:function:: Client.notice(target, message)
132
+
133
+    Sends a notice to the specified target.
134
+
135
+    :param string target: is either a nickname, or a channel.
136
+    :param string message: the message to send as a notice to the target.
137
+
138
+.. js:function:: Client.whois(nick, callback)
139
+
140
+    Request a whois for the specified `nick`.
141
+
142
+    :param string nick: is a nickname
143
+    :param function callback: Callback to fire when the server has finished
144
+        generating the whois information and is passed exactly the same
145
+        information as a `whois` event described above.
146
+
147
+.. js:function:: Client.list([arg1, arg2, ...])
148
+
149
+   Request a channel listing from the server. The arguments for this method are
150
+   fairly server specific, this method just passes them through exactly as
151
+   specified.
152
+
153
+   Responses from the server are available via the `channellist_start`,
154
+   `channellist_item`, and `channellist` events.
155
+
156
+.. js:function:: Client.connect([retryCount [, callback]])
157
+
158
+   Connects to the server. Used when `autoConnect` in the options is set to
159
+   false. If `retryCount` is a function it will be treated as the `callback`
160
+   (i.e. both arguments to this function are optional).
161
+
162
+    :param integer retryCount: Optional number of times to attempt reconnection
163
+    :param function callback: Optional callback
164
+
165
+.. js:function:: Client.disconnect([message [, callback]])
166
+
167
+    Disconnects from the IRC server. If `message` is a function it will be
168
+    treated as the `callback` (i.e. both arguments to this function are
169
+    optional).
170
+
171
+    :param string message: Optional message to send when disconnecting.
172
+    :param function callback: Optional callback
173
+
174
+.. js:function:: Client.activateFloodProtection([interval])
175
+
176
+    Activates flood protection "after the fact". You can also use
177
+    `floodProtection` while instantiating the Client to enable flood
178
+    protection, and `floodProtectionDelay` to set the default message
179
+    interval.
180
+
181
+    :param integer interval: Optional configuration for amount of time
182
+        to wait between messages. Takes value from client configuration
183
+        if unspecified.
184
+
185
+Events
186
+------
187
+
188
+`irc.Client` instances are EventEmitters with the following events:
189
+
190
+
191
+.. js:data:: 'registered'
192
+
193
+    `function (message) { }`
194
+
195
+    Emitted when the server sends the initial 001 line, indicating you've connected
196
+    to the server. See the `raw` event for details on the `message` object.
197
+
198
+.. js:data:: 'motd'
199
+
200
+    `function (motd) { }`
201
+
202
+    Emitted when the server sends the message of the day to clients.
203
+
204
+.. js:data:: 'names'
205
+
206
+    `function (channel, nicks) { }`
207
+
208
+    Emitted when the server sends a list of nicks for a channel (which happens
209
+    immediately after joining and on request. The nicks object passed to the
210
+    callback is keyed by nick names, and has values '', '+', or '@' depending on the
211
+    level of that nick in the channel.
212
+
213
+.. js:data:: 'names#channel'
214
+
215
+    `function (nicks) { }`
216
+
217
+    As per 'names' event but only emits for the subscribed channel.
218
+
219
+.. js:data:: 'topic'
220
+
221
+    `function (channel, topic, nick, message) { }`
222
+
223
+    Emitted when the server sends the channel topic on joining a channel, or when a
224
+    user changes the topic on a channel. See the `raw` event for details on the
225
+    `message` object.
226
+
227
+.. js:data:: 'join'
228
+
229
+    `function (channel, nick, message) { }`
230
+
231
+    Emitted when a user joins a channel (including when the client itself joins a
232
+    channel). See the `raw` event for details on the `message` object.
233
+
234
+.. js:data:: 'join#channel'
235
+
236
+    `function (nick, message) { }`
237
+
238
+    As per 'join' event but only emits for the subscribed channel.
239
+    See the `raw` event for details on the `message` object.
240
+
241
+.. js:data:: 'part'
242
+
243
+    `function (channel, nick, reason, message) { }`
244
+
245
+    Emitted when a user parts a channel (including when the client itself parts a
246
+    channel). See the `raw` event for details on the `message` object.
247
+
248
+.. js:data:: 'part#channel'
249
+
250
+    `function (nick, reason, message) { }`
251
+
252
+    As per 'part' event but only emits for the subscribed channel.
253
+    See the `raw` event for details on the `message` object.
254
+
255
+.. js:data:: 'quit'
256
+
257
+    `function (nick, reason, channels, message) { }`
258
+
259
+    Emitted when a user disconnects from the IRC, leaving the specified array of
260
+    channels. See the `raw` event for details on the `message` object.
261
+
262
+.. js:data:: 'kick'
263
+
264
+    `function (channel, nick, by, reason, message) { }`
265
+
266
+    Emitted when a user is kicked from a channel. See the `raw` event for details
267
+    on the `message` object.
268
+
269
+.. js:data:: 'kick#channel'
270
+
271
+    `function (nick, by, reason, message) { }`
272
+
273
+    As per 'kick' event but only emits for the subscribed channel.
274
+    See the `raw` event for details on the `message` object.
275
+
276
+.. js:data:: 'kill'
277
+
278
+    `function (nick, reason, channels, message) { }`
279
+
280
+    Emitted when a user is killed from the IRC server.
281
+    `channels` is an array of channels the killed user was in which
282
+    are known to the client.
283
+    See the `raw` event for details on the `message` object.
284
+
285
+.. js:data:: 'message'
286
+
287
+    `function (nick, to, text, message) { }`
288
+
289
+    Emitted when a message is sent. `to` can be either a nick (which is most likely
290
+    this clients nick and means a private message), or a channel (which means a
291
+    message to that channel). See the `raw` event for details on the `message` object.
292
+
293
+.. js:data:: 'message#'
294
+
295
+    `function (nick, to, text, message) { }`
296
+
297
+    Emitted when a message is sent to any channel (i.e. exactly the same as the
298
+    `message` event but excluding private messages.
299
+    See the `raw` event for details on the `message` object.
300
+
301
+.. js:data:: 'message#channel'
302
+
303
+    `function (nick, text, message) { }`
304
+
305
+    As per 'message' event but only emits for the subscribed channel.
306
+    See the `raw` event for details on the `message` object.
307
+
308
+.. js:data:: 'selfMessage'
309
+
310
+    `function (to, text) { }`
311
+
312
+    Emitted when a message is sent from the client. `to` is who the message was
313
+    sent to. It can be either a nick (which most likely means a private message),
314
+    or a channel (which means a message to that channel).
315
+
316
+.. js:data:: 'notice'
317
+
318
+    `function (nick, to, text, message) { }`
319
+
320
+    Emitted when a notice is sent. `to` can be either a nick (which is most likely
321
+    this clients nick and means a private message), or a channel (which means a
322
+    message to that channel). `nick` is either the senders nick or `null` which
323
+    means that the notice comes from the server. See the `raw` event for details
324
+    on the `message` object.
325
+
326
+.. js:data:: 'ping'
327
+
328
+   `function (server) { }`
329
+
330
+   Emitted when a server PINGs the client. The client will automatically send a
331
+   PONG request just before this is emitted.
332
+
333
+.. js:data:: 'pm'
334
+
335
+    `function (nick, text, message) { }`
336
+
337
+    As per 'message' event but only emits when the message is direct to the client.
338
+    See the `raw` event for details on the `message` object.
339
+
340
+.. js:data:: 'ctcp'
341
+
342
+   `function (from, to, text, type, message) { }`
343
+
344
+   Emitted when a CTCP notice or privmsg was received (`type` is either `'notice'`
345
+   or `'privmsg'`).  See the `raw` event for details on the `message` object.
346
+
347
+.. js:data:: 'ctcp-notice'
348
+
349
+   `function (from, to, text, message) { }`
350
+
351
+   Emitted when a CTCP notice was received.
352
+   See the `raw` event for details on the `message` object.
353
+
354
+.. js:data:: 'ctcp-privmsg'
355
+
356
+   `function (from, to, text, message) { }`
357
+
358
+   Emitted when a CTCP privmsg was received.
359
+   See the `raw` event for details on the `message` object.
360
+
361
+.. js:data:: 'ctcp-version'
362
+
363
+   `function (from, to, message) { }`
364
+
365
+   Emitted when a CTCP VERSION request was received.
366
+   See the `raw` event for details on the `message` object.
367
+
368
+.. js:data:: 'nick'
369
+
370
+    `function (oldnick, newnick, channels, message) { }`
371
+
372
+    Emitted when a user changes nick along with the channels the user is in.
373
+    See the `raw` event for details on the `message` object.
374
+
375
+.. js:data:: 'invite'
376
+
377
+    `function (channel, from, message) { }`
378
+
379
+    Emitted when the client receives an `/invite`. See the `raw` event for details
380
+    on the `message` object.
381
+
382
+.. js:data:: '+mode'
383
+
384
+  `function (channel, by, mode, argument, message) { }`
385
+
386
+    Emitted when a mode is added to a user or channel. `channel` is the channel
387
+    which the mode is being set on/in. `by` is the user setting the mode. `mode`
388
+    is the single character mode identifier. If the mode is being set on a user,
389
+    `argument` is the nick of the user.  If the mode is being set on a channel,
390
+    `argument` is the argument to the mode. If a channel mode doesn't have any
391
+    arguments, `argument` will be 'undefined'. See the `raw` event for details
392
+    on the `message` object.
393
+
394
+.. js:data:: '-mode'
395
+
396
+  `function (channel, by, mode, argument, message) { }`
397
+
398
+    Emitted when a mode is removed from a user or channel. `channel` is the channel
399
+    which the mode is being set on/in. `by` is the user setting the mode. `mode`
400
+    is the single character mode identifier. If the mode is being set on a user,
401
+    `argument` is the nick of the user.  If the mode is being set on a channel,
402
+    `argument` is the argument to the mode. If a channel mode doesn't have any
403
+    arguments, `argument` will be 'undefined'. See the `raw` event for details
404
+    on the `message` object.
405
+
406
+.. js:data:: 'whois'
407
+
408
+    `function (info) { }`
409
+
410
+    Emitted whenever the server finishes outputting a WHOIS response. The
411
+    information should look something like::
412
+
413
+        {
414
+            nick: "Ned",
415
+            user: "martyn",
416
+            host: "10.0.0.18",
417
+            realname: "Unknown",
418
+            channels: ["@#purpledishwashers", "#blah", "#mmmmbacon"],
419
+            server: "*.dollyfish.net.nz",
420
+            serverinfo: "The Dollyfish Underworld",
421
+            operator: "is an IRC Operator"
422
+        }
423
+
424
+.. js:data:: 'channellist_start'
425
+
426
+    `function () {}`
427
+
428
+    Emitted whenever the server starts a new channel listing
429
+
430
+.. js:data:: 'channellist_item'
431
+
432
+   `function (channel_info) {}`
433
+
434
+   Emitted for each channel the server returns. The channel_info object
435
+   contains keys 'name', 'users' (number of users on the channel), and 'topic'.
436
+
437
+.. js:data:: 'channellist'
438
+
439
+   `function (channel_list) {}`
440
+
441
+   Emitted when the server has finished returning a channel list. The
442
+   channel_list array is simply a list of the objects that were returned in the
443
+   intervening `channellist_item` events.
444
+
445
+   This data is also available via the Client.channellist property after this
446
+   event has fired.
447
+
448
+.. js:data:: 'raw'
449
+
450
+    `function (message) { }`
451
+
452
+    Emitted when ever the client receives a "message" from the server. A message is
453
+    basically a single line of data from the server, but the parameter to the
454
+    callback has already been parsed and contains::
455
+
456
+        message = {
457
+            prefix: "The prefix for the message (optional)",
458
+            nick: "The nickname portion of the prefix (optional)",
459
+            user: "The username portion of the prefix (optional)",
460
+            host: "The hostname portion of the prefix (optional)",
461
+            server: "The servername (if the prefix was a servername)",
462
+            rawCommand: "The command exactly as sent from the server",
463
+            command: "Human readable version of the command",
464
+            commandType: "normal, error, or reply",
465
+            args: ['arguments', 'to', 'the', 'command'],
466
+        }
467
+
468
+    You can read more about the IRC protocol by reading `RFC 1459
469
+    <http://www.ietf.org/rfc/rfc1459.txt>`_
470
+
471
+.. js:data:: 'error'
472
+
473
+    `function (message) { }`
474
+
475
+    Emitted when ever the server responds with an error-type message. The message
476
+    parameter is exactly as in the 'raw' event.
477
+
478
+.. js:data:: 'action'
479
+
480
+    `function (from, to, text, message) { }`
481
+
482
+    Emitted whenever a user performs an action (e.g. `/me waves`).
483
+    The message parameter is exactly as in the 'raw' event.
484
+
485
+Colors
486
+------
487
+
488
+.. js:function:: irc.colors.wrap(color, text [, reset_color])
489
+
490
+    Takes a color by name, text, and optionally what color to return.
491
+
492
+    :param string color: the name of the color as a string
493
+    :param string text: the text you want colorized
494
+    :param string reset_color: the name of the color you want set after the text (defaults to 'reset')
495
+
496
+.. js:data:: irc.colors.codes
497
+
498
+    This contains the set of colors available and a function to wrap text in a
499
+    color.
500
+
501
+    The following color choices are available:
502
+
503
+    {
504
+        white: '\u000300',
505
+        black: '\u000301',
506
+        dark_blue: '\u000302',
507
+        dark_green: '\u000303',
508
+        light_red: '\u000304',
509
+        dark_red: '\u000305',
510
+        magenta: '\u000306',
511
+        orange: '\u000307',
512
+        yellow: '\u000308',
513
+        light_green: '\u000309',
514
+        cyan: '\u000310',
515
+        light_cyan: '\u000311',
516
+        light_blue: '\u000312',
517
+        light_magenta: '\u000313',
518
+        gray: '\u000314',
519
+        light_gray: '\u000315',
520
+        reset: '\u000f',
521
+    }
522
+
523
+Internal
524
+------
525
+
526
+.. js:data:: Client.conn
527
+
528
+    Socket to the server. Rarely, if ever needed. Use `Client.send` instead.
529
+
530
+.. js:data:: Client.chans
531
+
532
+    Channels joined. Includes channel modes, user list, and topic information. Only updated *after* the server recognizes the join.
533
+
534
+.. js:data:: Client.nick
535
+
536
+    The current nick of the client. Updated if the nick changes (e.g. nick collision when connecting to a server).
537
+
538
+.. js:function:: client._whoisData
539
+
540
+    Buffer of whois data as whois is sent over multiple lines.
541
+
542
+.. js:function:: client._addWhoisData
543
+
544
+    Self-explanatory.
545
+
546
+.. js:function:: client._clearWhoisData
547
+
548
+    Self-explanatory.
... ...
@@ -0,0 +1,130 @@
1
+# Makefile for Sphinx documentation
2
+#
3
+
4
+# You can set these variables from the command line.
5
+SPHINXOPTS    =
6
+SPHINXBUILD   = sphinx-build
7
+PAPER         =
8
+BUILDDIR      = _build
9
+
10
+# Internal variables.
11
+PAPEROPT_a4     = -D latex_paper_size=a4
12
+PAPEROPT_letter = -D latex_paper_size=letter
13
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
14
+
15
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
16
+
17
+help:
18
+	@echo "Please use \`make <target>' where <target> is one of"
19
+	@echo "  html       to make standalone HTML files"
20
+	@echo "  dirhtml    to make HTML files named index.html in directories"
21
+	@echo "  singlehtml to make a single large HTML file"
22
+	@echo "  pickle     to make pickle files"
23
+	@echo "  json       to make JSON files"
24
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
25
+	@echo "  qthelp     to make HTML files and a qthelp project"
26
+	@echo "  devhelp    to make HTML files and a Devhelp project"
27
+	@echo "  epub       to make an epub"
28
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
30
+	@echo "  text       to make text files"
31
+	@echo "  man        to make manual pages"
32
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
33
+	@echo "  linkcheck  to check all external links for integrity"
34
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
35
+
36
+clean:
37
+	-rm -rf $(BUILDDIR)/*
38
+
39
+html:
40
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
41
+	@echo
42
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
43
+
44
+dirhtml:
45
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
46
+	@echo
47
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
48
+
49
+singlehtml:
50
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
51
+	@echo
52
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
53
+
54
+pickle:
55
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
56
+	@echo
57
+	@echo "Build finished; now you can process the pickle files."
58
+
59
+json:
60
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
61
+	@echo
62
+	@echo "Build finished; now you can process the JSON files."
63
+
64
+htmlhelp:
65
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
66
+	@echo
67
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
68
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
69
+
70
+qthelp:
71
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
72
+	@echo
73
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
74
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
75
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/node-irc.qhcp"
76
+	@echo "To view the help file:"
77
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/node-irc.qhc"
78
+
79
+devhelp:
80
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
81
+	@echo
82
+	@echo "Build finished."
83
+	@echo "To view the help file:"
84
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/node-irc"
85
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/node-irc"
86
+	@echo "# devhelp"
87
+
88
+epub:
89
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
90
+	@echo
91
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
92
+
93
+latex:
94
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
95
+	@echo
96
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
97
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
98
+	      "(use \`make latexpdf' here to do that automatically)."
99
+
100
+latexpdf:
101
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
102
+	@echo "Running LaTeX files through pdflatex..."
103
+	make -C $(BUILDDIR)/latex all-pdf
104
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
105
+
106
+text:
107
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
108
+	@echo
109
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
110
+
111
+man:
112
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
113
+	@echo
114
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
115
+
116
+changes:
117
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
118
+	@echo
119
+	@echo "The overview file is in $(BUILDDIR)/changes."
120
+
121
+linkcheck:
122
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
123
+	@echo
124
+	@echo "Link check complete; look for any errors in the above output " \
125
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
126
+
127
+doctest:
128
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
129
+	@echo "Testing of doctests in the sources finished, look at the " \
130
+	      "results in $(BUILDDIR)/doctest/output.txt."
... ...
@@ -0,0 +1,216 @@
1
+# -*- coding: utf-8 -*-
2
+#
3
+# node-irc documentation build configuration file, created by
4
+# sphinx-quickstart on Sat Oct  1 00:02:31 2011.
5
+#
6
+# This file is execfile()d with the current directory set to its containing dir.
7
+#
8
+# Note that not all possible configuration values are present in this
9
+# autogenerated file.
10
+#
11
+# All configuration values have a default; values that are commented out
12
+# serve to show the default.
13
+
14
+import sys, os
15
+
16
+# If extensions (or modules to document with autodoc) are in another directory,
17
+# add these directories to sys.path here. If the directory is relative to the
18
+# documentation root, use os.path.abspath to make it absolute, like shown here.
19
+#sys.path.insert(0, os.path.abspath('.'))
20
+
21
+# -- General configuration -----------------------------------------------------
22
+
23
+# If your documentation needs a minimal Sphinx version, state it here.
24
+#needs_sphinx = '1.0'
25
+
26
+# Add any Sphinx extension module names here, as strings. They can be extensions
27
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28
+extensions = []
29
+
30
+# Add any paths that contain templates here, relative to this directory.
31
+templates_path = ['_templates']
32
+
33
+# The suffix of source filenames.
34
+source_suffix = '.rst'
35
+
36
+# The encoding of source files.
37
+#source_encoding = 'utf-8-sig'
38
+
39
+# The master toctree document.
40
+master_doc = 'index'
41
+
42
+# General information about the project.
43
+project = u'node-irc'
44
+copyright = u'2011, Martyn Smith'
45
+
46
+# The version info for the project you're documenting, acts as replacement for
47
+# |version| and |release|, also used in various other places throughout the
48
+# built documents.
49
+#
50
+# The short X.Y version.
51
+version = '2.1'
52
+# The full version, including alpha/beta/rc tags.
53
+release = '2.1'
54
+
55
+# The language for content autogenerated by Sphinx. Refer to documentation
56
+# for a list of supported languages.
57
+#language = None
58
+
59
+# There are two options for replacing |today|: either, you set today to some
60
+# non-false value, then it is used:
61
+#today = ''
62
+# Else, today_fmt is used as the format for a strftime call.
63
+#today_fmt = '%B %d, %Y'
64
+
65
+# List of patterns, relative to source directory, that match files and
66
+# directories to ignore when looking for source files.
67
+exclude_patterns = ['_build']
68
+
69
+# The reST default role (used for this markup: `text`) to use for all documents.
70
+#default_role = None
71
+
72
+# If true, '()' will be appended to :func: etc. cross-reference text.
73
+#add_function_parentheses = True
74
+
75
+# If true, the current module name will be prepended to all description
76
+# unit titles (such as .. function::).
77
+#add_module_names = True
78
+
79
+# If true, sectionauthor and moduleauthor directives will be shown in the
80
+# output. They are ignored by default.
81
+#show_authors = False
82
+
83
+# The name of the Pygments (syntax highlighting) style to use.
84
+pygments_style = 'sphinx'
85
+
86
+# A list of ignored prefixes for module index sorting.
87
+#modindex_common_prefix = []
88
+
89
+
90
+# -- Options for HTML output ---------------------------------------------------
91
+
92
+# The theme to use for HTML and HTML Help pages.  See the documentation for
93
+# a list of builtin themes.
94
+html_theme = 'default'
95
+
96
+# Theme options are theme-specific and customize the look and feel of a theme
97
+# further.  For a list of options available for each theme, see the
98
+# documentation.
99
+#html_theme_options = {}
100
+
101
+# Add any paths that contain custom themes here, relative to this directory.
102
+#html_theme_path = []
103
+
104
+# The name for this set of Sphinx documents.  If None, it defaults to
105
+# "<project> v<release> documentation".
106
+#html_title = None
107
+
108
+# A shorter title for the navigation bar.  Default is the same as html_title.
109
+#html_short_title = None
110
+
111
+# The name of an image file (relative to this directory) to place at the top
112
+# of the sidebar.
113
+#html_logo = None
114
+
115
+# The name of an image file (within the static path) to use as favicon of the
116
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
117
+# pixels large.
118
+#html_favicon = None
119
+
120
+# Add any paths that contain custom static files (such as style sheets) here,
121
+# relative to this directory. They are copied after the builtin static files,
122
+# so a file named "default.css" will overwrite the builtin "default.css".
123
+html_static_path = ['_static']
124
+
125
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126
+# using the given strftime format.
127
+#html_last_updated_fmt = '%b %d, %Y'
128
+
129
+# If true, SmartyPants will be used to convert quotes and dashes to
130
+# typographically correct entities.
131
+#html_use_smartypants = True
132
+
133
+# Custom sidebar templates, maps document names to template names.
134
+#html_sidebars = {}
135
+
136
+# Additional templates that should be rendered to pages, maps page names to
137
+# template names.
138
+#html_additional_pages = {}
139
+
140
+# If false, no module index is generated.
141
+#html_domain_indices = True
142
+
143
+# If false, no index is generated.
144
+#html_use_index = True
145
+
146
+# If true, the index is split into individual pages for each letter.
147
+#html_split_index = False
148
+
149
+# If true, links to the reST sources are added to the pages.
150
+#html_show_sourcelink = True
151
+
152
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
153
+#html_show_sphinx = True
154
+
155
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
156
+#html_show_copyright = True
157
+
158
+# If true, an OpenSearch description file will be output, and all pages will
159
+# contain a <link> tag referring to it.  The value of this option must be the
160
+# base URL from which the finished HTML is served.
161
+#html_use_opensearch = ''
162
+
163
+# This is the file name suffix for HTML files (e.g. ".xhtml").
164
+#html_file_suffix = None
165
+
166
+# Output file base name for HTML help builder.
167
+htmlhelp_basename = 'node-ircdoc'
168
+
169
+
170
+# -- Options for LaTeX output --------------------------------------------------
171
+
172
+# The paper size ('letter' or 'a4').
173
+#latex_paper_size = 'letter'
174
+
175
+# The font size ('10pt', '11pt' or '12pt').
176
+#latex_font_size = '10pt'
177
+
178
+# Grouping the document tree into LaTeX files. List of tuples
179
+# (source start file, target name, title, author, documentclass [howto/manual]).
180
+latex_documents = [
181
+  ('index', 'node-irc.tex', u'node-irc Documentation',
182
+   u'Martyn Smith', 'manual'),
183
+]
184
+
185
+# The name of an image file (relative to this directory) to place at the top of
186
+# the title page.
187
+#latex_logo = None
188
+
189
+# For "manual" documents, if this is true, then toplevel headings are parts,
190
+# not chapters.
191
+#latex_use_parts = False
192
+
193
+# If true, show page references after internal links.
194
+#latex_show_pagerefs = False
195
+
196
+# If true, show URL addresses after external links.
197
+#latex_show_urls = False
198
+
199
+# Additional stuff for the LaTeX preamble.
200
+#latex_preamble = ''
201
+
202
+# Documents to append as an appendix to all manuals.
203
+#latex_appendices = []
204
+
205
+# If false, no module index is generated.
206
+#latex_domain_indices = True
207
+
208
+
209
+# -- Options for manual page output --------------------------------------------
210
+
211
+# One entry per manual page. List of tuples
212
+# (source start file, name, description, authors, manual section).
213
+man_pages = [
214
+    ('index', 'node-irc', u'node-irc Documentation',
215
+     [u'Martyn Smith'], 1)
216
+]
... ...
@@ -0,0 +1,13 @@
1
+Welcome to node-irc's documentation!
2
+====================================
3
+
4
+.. include:: ../README.rst
5
+
6
+More detailed docs:
7
+-------------------
8
+
9
+.. toctree::
10
+   :maxdepth: 2
11
+
12
+   API
13
+
... ...
@@ -0,0 +1,170 @@
1
+@ECHO OFF
2
+
3
+REM Command file for Sphinx documentation
4
+
5
+if "%SPHINXBUILD%" == "" (
6
+	set SPHINXBUILD=sphinx-build
7
+)
8
+set BUILDDIR=_build
9
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10
+if NOT "%PAPER%" == "" (
11
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
12
+)
13
+
14
+if "%1" == "" goto help
15
+
16
+if "%1" == "help" (
17
+	:help
18
+	echo.Please use `make ^<target^>` where ^<target^> is one of
19
+	echo.  html       to make standalone HTML files
20
+	echo.  dirhtml    to make HTML files named index.html in directories
21
+	echo.  singlehtml to make a single large HTML file
22
+	echo.  pickle     to make pickle files
23
+	echo.  json       to make JSON files
24
+	echo.  htmlhelp   to make HTML files and a HTML help project
25
+	echo.  qthelp     to make HTML files and a qthelp project
26
+	echo.  devhelp    to make HTML files and a Devhelp project
27
+	echo.  epub       to make an epub
28
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
29
+	echo.  text       to make text files
30
+	echo.  man        to make manual pages
31
+	echo.  changes    to make an overview over all changed/added/deprecated items
32
+	echo.  linkcheck  to check all external links for integrity
33
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
34
+	goto end
35
+)
36
+
37
+if "%1" == "clean" (
38
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
39
+	del /q /s %BUILDDIR%\*
40
+	goto end
41
+)
42
+
43
+if "%1" == "html" (
44
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
45
+	if errorlevel 1 exit /b 1
46
+	echo.
47
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
48
+	goto end
49
+)
50
+
51
+if "%1" == "dirhtml" (
52
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
53
+	if errorlevel 1 exit /b 1
54
+	echo.
55
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
56
+	goto end
57
+)
58
+
59
+if "%1" == "singlehtml" (
60
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
61
+	if errorlevel 1 exit /b 1
62
+	echo.
63
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
64
+	goto end
65
+)
66
+
67
+if "%1" == "pickle" (
68
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
69
+	if errorlevel 1 exit /b 1
70
+	echo.
71
+	echo.Build finished; now you can process the pickle files.
72
+	goto end
73
+)
74
+
75
+if "%1" == "json" (
76
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
77
+	if errorlevel 1 exit /b 1
78
+	echo.
79
+	echo.Build finished; now you can process the JSON files.
80
+	goto end
81
+)
82
+
83
+if "%1" == "htmlhelp" (
84
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
85
+	if errorlevel 1 exit /b 1
86
+	echo.
87
+	echo.Build finished; now you can run HTML Help Workshop with the ^
88
+.hhp project file in %BUILDDIR%/htmlhelp.
89
+	goto end
90
+)
91
+
92
+if "%1" == "qthelp" (
93
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
94
+	if errorlevel 1 exit /b 1
95
+	echo.
96
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
97
+.qhcp project file in %BUILDDIR%/qthelp, like this:
98
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\node-irc.qhcp
99
+	echo.To view the help file:
100
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\node-irc.ghc
101
+	goto end
102
+)
103
+
104
+if "%1" == "devhelp" (
105
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
106
+	if errorlevel 1 exit /b 1
107
+	echo.
108
+	echo.Build finished.
109
+	goto end
110
+)
111
+
112
+if "%1" == "epub" (
113
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
114
+	if errorlevel 1 exit /b 1
115
+	echo.
116
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
117
+	goto end
118
+)
119
+
120
+if "%1" == "latex" (
121
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
122
+	if errorlevel 1 exit /b 1
123
+	echo.
124
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
125
+	goto end
126
+)
127
+
128
+if "%1" == "text" (
129
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
130
+	if errorlevel 1 exit /b 1
131
+	echo.
132
+	echo.Build finished. The text files are in %BUILDDIR%/text.
133
+	goto end
134
+)
135
+
136
+if "%1" == "man" (
137
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
138
+	if errorlevel 1 exit /b 1
139
+	echo.
140
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
141
+	goto end
142
+)
143
+
144
+if "%1" == "changes" (
145
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
146
+	if errorlevel 1 exit /b 1
147
+	echo.
148
+	echo.The overview file is in %BUILDDIR%/changes.
149
+	goto end
150
+)
151
+
152
+if "%1" == "linkcheck" (
153
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
154
+	if errorlevel 1 exit /b 1
155
+	echo.
156
+	echo.Link check complete; look for any errors in the above output ^
157
+or in %BUILDDIR%/linkcheck/output.txt.
158
+	goto end
159
+)
160
+
161
+if "%1" == "doctest" (
162
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
163
+	if errorlevel 1 exit /b 1
164
+	echo.
165
+	echo.Testing of doctests in the sources finished, look at the ^
166
+results in %BUILDDIR%/doctest/output.txt.
167
+	goto end
168
+)
169
+
170
+:end
... ...
@@ -0,0 +1,49 @@
1
+#!/usr/bin/env node
2
+
3
+var irc = require('../');
4
+
5
+var bot = new irc.Client('irc.dollyfish.net.nz', 'nodebot', {
6
+    debug: true,
7
+    channels: ['#test', '#othertest']
8
+});
9
+
10
+bot.addListener('error', function(message) {
11
+    console.error('ERROR: %s: %s', message.command, message.args.join(' '));
12
+});
13
+
14
+bot.addListener('message#blah', function(from, message) {
15
+    console.log('<%s> %s', from, message);
16
+});
17
+
18
+bot.addListener('message', function(from, to, message) {
19
+    console.log('%s => %s: %s', from, to, message);
20
+
21
+    if (to.match(/^[#&]/)) {
22
+        // channel message
23
+        if (message.match(/hello/i)) {
24
+            bot.say(to, 'Hello there ' + from);
25
+        }
26
+        if (message.match(/dance/)) {
27
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D\\-<\u0001'); }, 1000);
28
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D|-<\u0001');  }, 2000);
29
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D/-<\u0001');  }, 3000);
30
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D|-<\u0001');  }, 4000);
31
+        }
32
+    }
33
+    else {
34
+        // private message
35
+        console.log('private message');
36
+    }
37
+});
38
+bot.addListener('pm', function(nick, message) {
39
+    console.log('Got private message from %s: %s', nick, message);
40
+});
41
+bot.addListener('join', function(channel, who) {
42
+    console.log('%s has joined %s', who, channel);
43
+});
44
+bot.addListener('part', function(channel, who, reason) {
45
+    console.log('%s has left %s: %s', who, channel, reason);
46
+});
47
+bot.addListener('kick', function(channel, who, by, reason) {
48
+    console.log('%s was kicked from %s by %s: %s', who, channel, by, reason);
49
+});
... ...
@@ -0,0 +1,63 @@
1
+#!/usr/bin/env node
2
+
3
+var irc = require('../');
4
+/*
5
+* To set the key/cert explicitly, you could do the following
6
+var fs = require('fs');
7
+
8
+var options = {
9
+  key: fs.readFileSync('privkey.pem'),
10
+  cert: fs.readFileSync('certificate.crt')
11
+};
12
+*/
13
+
14
+// Or to just use defaults
15
+var options = true;
16
+
17
+var bot = new irc.Client('chat.us.freenode.net', 'nodebot', {
18
+	port: 6697,
19
+    debug: true,
20
+	secure: options,
21
+    channels: ['#botwar']
22
+});
23
+
24
+bot.addListener('error', function(message) {
25
+    console.error('ERROR: %s: %s', message.command, message.args.join(' '));
26
+});
27
+
28
+bot.addListener('message#blah', function(from, message) {
29
+    console.log('<%s> %s', from, message);
30
+});
31
+
32
+bot.addListener('message', function(from, to, message) {
33
+    console.log('%s => %s: %s', from, to, message);
34
+
35
+    if (to.match(/^[#&]/)) {
36
+        // channel message
37
+        if (message.match(/hello/i)) {
38
+            bot.say(to, 'Hello there ' + from);
39
+        }
40
+        if (message.match(/dance/)) {
41
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D\\-<\u0001'); }, 1000);
42
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D|-<\u0001');  }, 2000);
43
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D/-<\u0001');  }, 3000);
44
+            setTimeout(function() { bot.say(to, '\u0001ACTION dances: :D|-<\u0001');  }, 4000);
45
+        }
46
+    }
47
+    else {
48
+        // private message
49
+        console.log('private message');
50
+    }
51
+});
52
+bot.addListener('pm', function(nick, message) {
53
+    console.log('Got private message from %s: %s', nick, message);
54
+});
55
+bot.addListener('join', function(channel, who) {
56
+    console.log('%s has joined %s', who, channel);
57
+});
58
+bot.addListener('part', function(channel, who, reason) {
59
+    console.log('%s has left %s: %s', who, channel, reason);
60
+});
61
+bot.addListener('kick', function(channel, who, by, reason) {
62
+    console.log('%s was kicked from %s by %s: %s', who, channel, by, reason);
63
+});
... ...
@@ -0,0 +1,514 @@
1
+module.exports = {
2
+   '001': {
3
+      name: 'rpl_welcome',
4
+      type: 'reply'
5
+   },
6
+   '002': {
7
+      name: 'rpl_yourhost',
8
+      type: 'reply'
9
+   },
10
+   '003': {
11
+      name: 'rpl_created',
12
+      type: 'reply'
13
+   },
14
+   '004': {
15
+      name: 'rpl_myinfo',
16
+      type: 'reply'
17
+   },
18
+   '005': {
19
+      name: 'rpl_isupport',
20
+      type: 'reply'
21
+   },
22
+   200: {
23
+      name: 'rpl_tracelink',
24
+      type: 'reply'
25
+   },
26
+   201: {
27
+      name: 'rpl_traceconnecting',
28
+      type: 'reply'
29
+   },
30
+   202: {
31
+      name: 'rpl_tracehandshake',
32
+      type: 'reply'
33
+   },
34
+   203: {
35
+      name: 'rpl_traceunknown',
36
+      type: 'reply'
37
+   },
38
+   204: {
39
+      name: 'rpl_traceoperator',
40
+      type: 'reply'
41
+   },
42
+   205: {
43
+      name: 'rpl_traceuser',
44
+      type: 'reply'
45
+   },
46
+   206: {
47
+      name: 'rpl_traceserver',
48
+      type: 'reply'
49
+   },
50
+   208: {
51
+      name: 'rpl_tracenewtype',
52
+      type: 'reply'
53
+   },
54
+   211: {
55
+      name: 'rpl_statslinkinfo',
56
+      type: 'reply'
57
+   },
58
+   212: {
59
+      name: 'rpl_statscommands',
60
+      type: 'reply'
61
+   },
62
+   213: {
63
+      name: 'rpl_statscline',
64
+      type: 'reply'
65
+   },
66
+   214: {
67
+      name: 'rpl_statsnline',
68
+      type: 'reply'
69
+   },
70
+   215: {
71
+      name: 'rpl_statsiline',
72
+      type: 'reply'
73
+   },
74
+   216: {
75
+      name: 'rpl_statskline',
76
+      type: 'reply'
77
+   },
78
+   218: {
79
+      name: 'rpl_statsyline',
80
+      type: 'reply'
81
+   },
82
+   219: {
83
+      name: 'rpl_endofstats',
84
+      type: 'reply'
85
+   },
86
+   221: {
87
+      name: 'rpl_umodeis',
88
+      type: 'reply'
89
+   },
90
+   241: {
91
+      name: 'rpl_statslline',
92
+      type: 'reply'
93
+   },
94
+   242: {
95
+      name: 'rpl_statsuptime',
96
+      type: 'reply'
97
+   },
98
+   243: {
99
+      name: 'rpl_statsoline',
100
+      type: 'reply'
101
+   },
102
+   244: {
103
+      name: 'rpl_statshline',
104
+      type: 'reply'
105
+   },
106
+   250: {
107
+      name: 'rpl_statsconn',
108
+      type: 'reply'
109
+   },
110
+   251: {
111
+      name: 'rpl_luserclient',
112
+      type: 'reply'
113
+   },
114
+   252: {
115
+      name: 'rpl_luserop',
116
+      type: 'reply'
117
+   },
118
+   253: {
119
+      name: 'rpl_luserunknown',
120
+      type: 'reply'
121
+   },
122
+   254: {
123
+      name: 'rpl_luserchannels',
124
+      type: 'reply'
125
+   },
126
+   255: {
127
+      name: 'rpl_luserme',
128
+      type: 'reply'
129
+   },
130
+   256: {
131
+      name: 'rpl_adminme',
132
+      type: 'reply'
133
+   },
134
+   257: {
135
+      name: 'rpl_adminloc1',
136
+      type: 'reply'
137
+   },
138
+   258: {
139
+      name: 'rpl_adminloc2',
140
+      type: 'reply'
141
+   },
142
+   259: {
143
+      name: 'rpl_adminemail',
144
+      type: 'reply'
145
+   },
146
+   261: {
147
+      name: 'rpl_tracelog',
148
+      type: 'reply'
149
+   },
150
+   265: {
151
+      name: 'rpl_localusers',
152
+      type: 'reply'
153
+   },
154
+   266: {
155
+      name: 'rpl_globalusers',
156
+      type: 'reply'
157
+   },
158
+   300: {
159
+      name: 'rpl_none',
160
+      type: 'reply'
161
+   },
162
+   301: {
163
+      name: 'rpl_away',
164
+      type: 'reply'
165
+   },
166
+   302: {
167
+      name: 'rpl_userhost',
168
+      type: 'reply'
169
+   },
170
+   303: {
171
+      name: 'rpl_ison',
172
+      type: 'reply'
173
+   },
174
+   305: {
175
+      name: 'rpl_unaway',
176
+      type: 'reply'
177
+   },
178
+   306: {
179
+      name: 'rpl_nowaway',
180
+      type: 'reply'
181
+   },
182
+   311: {
183
+      name: 'rpl_whoisuser',
184
+      type: 'reply'
185
+   },
186
+   312: {
187
+      name: 'rpl_whoisserver',
188
+      type: 'reply'
189
+   },
190
+   313: {
191
+      name: 'rpl_whoisoperator',
192
+      type: 'reply'
193
+   },
194
+   314: {
195
+      name: 'rpl_whowasuser',
196
+      type: 'reply'
197
+   },
198
+   315: {
199
+      name: 'rpl_endofwho',
200
+      type: 'reply'
201
+   },
202
+   317: {
203
+      name: 'rpl_whoisidle',
204
+      type: 'reply'
205
+   },
206
+   318: {
207
+      name: 'rpl_endofwhois',
208
+      type: 'reply'
209
+   },
210
+   319: {
211
+      name: 'rpl_whoischannels',
212
+      type: 'reply'
213
+   },
214
+   321: {
215
+      name: 'rpl_liststart',
216
+      type: 'reply'
217
+   },
218
+   322: {
219
+      name: 'rpl_list',
220
+      type: 'reply'
221
+   },
222
+   323: {
223
+      name: 'rpl_listend',
224
+      type: 'reply'
225
+   },
226
+   324: {
227
+      name: 'rpl_channelmodeis',
228
+      type: 'reply'
229
+   },
230
+   329: {
231
+      name: 'rpl_creationtime',
232
+      type: 'reply'
233
+   },
234
+   331: {
235
+      name: 'rpl_notopic',
236
+      type: 'reply'
237
+   },
238
+   332: {
239
+      name: 'rpl_topic',
240
+      type: 'reply'
241
+   },
242
+   333: {
243
+      name: 'rpl_topicwhotime',
244
+      type: 'reply'
245
+   },
246
+   341: {
247
+      name: 'rpl_inviting',
248
+      type: 'reply'
249
+   },
250
+   342: {
251
+      name: 'rpl_summoning',
252
+      type: 'reply'
253
+   },
254
+   351: {
255
+      name: 'rpl_version',
256
+      type: 'reply'
257
+   },
258
+   352: {
259
+      name: 'rpl_whoreply',
260
+      type: 'reply'
261
+   },
262
+   353: {
263
+      name: 'rpl_namreply',
264
+      type: 'reply'
265
+   },
266
+   364: {
267
+      name: 'rpl_links',
268
+      type: 'reply'
269
+   },
270
+   365: {
271
+      name: 'rpl_endoflinks',
272
+      type: 'reply'
273
+   },
274
+   366: {
275
+      name: 'rpl_endofnames',
276
+      type: 'reply'
277
+   },
278
+   367: {
279
+      name: 'rpl_banlist',
280
+      type: 'reply'
281
+   },
282
+   368: {
283
+      name: 'rpl_endofbanlist',
284
+      type: 'reply'
285
+   },
286
+   369: {
287
+      name: 'rpl_endofwhowas',
288
+      type: 'reply'
289
+   },
290
+   371: {
291
+      name: 'rpl_info',
292
+      type: 'reply'
293
+   },
294
+   372: {
295
+      name: 'rpl_motd',
296
+      type: 'reply'
297
+   },
298
+   374: {
299
+      name: 'rpl_endofinfo',
300
+      type: 'reply'
301
+   },
302
+   375: {
303
+      name: 'rpl_motdstart',
304
+      type: 'reply'
305
+   },
306
+   376: {
307
+      name: 'rpl_endofmotd',
308
+      type: 'reply'
309
+   },
310
+   381: {
311
+      name: 'rpl_youreoper',
312
+      type: 'reply'
313
+   },
314
+   382: {
315
+      name: 'rpl_rehashing',
316
+      type: 'reply'
317
+   },
318
+   391: {
319
+      name: 'rpl_time',
320
+      type: 'reply'
321
+   },
322
+   392: {
323
+      name: 'rpl_usersstart',
324
+      type: 'reply'
325
+   },
326
+   393: {
327
+      name: 'rpl_users',
328
+      type: 'reply'
329
+   },
330
+   394: {
331
+      name: 'rpl_endofusers',
332
+      type: 'reply'
333
+   },
334
+   395: {
335
+      name: 'rpl_nousers',
336
+      type: 'reply'
337
+   },
338
+   401: {
339
+      name: 'err_nosuchnick',
340
+      type: 'error'
341
+   },
342
+   402: {
343
+      name: 'err_nosuchserver',
344
+      type: 'error'
345
+   },
346
+   403: {
347
+      name: 'err_nosuchchannel',
348
+      type: 'error'
349
+   },
350
+   404: {
351
+      name: 'err_cannotsendtochan',
352
+      type: 'error'
353
+   },
354
+   405: {
355
+      name: 'err_toomanychannels',
356
+      type: 'error'
357
+   },
358
+   406: {
359
+      name: 'err_wasnosuchnick',
360
+      type: 'error'
361
+   },
362
+   407: {
363
+      name: 'err_toomanytargets',
364
+      type: 'error'
365
+   },
366
+   409: {
367
+      name: 'err_noorigin',
368
+      type: 'error'
369
+   },
370
+   411: {
371
+      name: 'err_norecipient',
372
+      type: 'error'
373
+   },
374
+   412: {
375
+      name: 'err_notexttosend',
376
+      type: 'error'
377
+   },
378
+   413: {
379
+      name: 'err_notoplevel',
380
+      type: 'error'
381
+   },
382
+   414: {
383
+      name: 'err_wildtoplevel',
384
+      type: 'error'
385
+   },
386
+   421: {
387
+      name: 'err_unknowncommand',
388
+      type: 'error'
389
+   },
390
+   422: {
391
+      name: 'err_nomotd',
392
+      type: 'error'
393
+   },
394
+   423: {
395
+      name: 'err_noadmininfo',
396
+      type: 'error'
397
+   },
398
+   424: {
399
+      name: 'err_fileerror',
400
+      type: 'error'
401
+   },
402
+   431: {
403
+      name: 'err_nonicknamegiven',
404
+      type: 'error'
405
+   },
406
+   432: {
407
+      name: 'err_erroneusnickname',
408
+      type: 'error'
409
+   },
410
+   433: {
411
+      name: 'err_nicknameinuse',
412
+      type: 'error'
413
+   },
414
+   436: {
415
+      name: 'err_nickcollision',
416
+      type: 'error'
417
+   },
418
+   441: {
419
+      name: 'err_usernotinchannel',
420
+      type: 'error'
421
+   },
422
+   442: {
423
+      name: 'err_notonchannel',
424
+      type: 'error'
425
+   },
426
+   443: {
427
+      name: 'err_useronchannel',
428
+      type: 'error'
429
+   },
430
+   444: {
431
+      name: 'err_nologin',
432
+      type: 'error'
433
+   },
434
+   445: {
435
+      name: 'err_summondisabled',
436
+      type: 'error'
437
+   },
438
+   446: {
439
+      name: 'err_usersdisabled',
440
+      type: 'error'
441
+   },
442
+   451: {
443
+      name: 'err_notregistered',
444
+      type: 'error'
445
+   },
446
+   461: {
447
+      name: 'err_needmoreparams',
448
+      type: 'error'
449
+   },
450
+   462: {
451
+      name: 'err_alreadyregistred',
452
+      type: 'error'
453
+   },
454
+   463: {
455
+      name: 'err_nopermforhost',
456
+      type: 'error'
457
+   },
458
+   464: {
459
+      name: 'err_passwdmismatch',
460
+      type: 'error'
461
+   },
462
+   465: {
463
+      name: 'err_yourebannedcreep',
464
+      type: 'error'
465
+   },
466
+   467: {
467
+      name: 'err_keyset',
468
+      type: 'error'
469
+   },
470
+   471: {
471
+      name: 'err_channelisfull',
472
+      type: 'error'
473
+   },
474
+   472: {
475
+      name: 'err_unknownmode',
476
+      type: 'error'
477
+   },
478
+   473: {
479
+      name: 'err_inviteonlychan',
480
+      type: 'error'
481
+   },
482
+   474: {
483
+      name: 'err_bannedfromchan',
484
+      type: 'error'
485
+   },
486
+   475: {
487
+      name: 'err_badchannelkey',
488
+      type: 'error'
489
+   },
490
+   481: {
491
+      name: 'err_noprivileges',
492
+      type: 'error'
493
+   },
494
+   482: {
495
+      name: 'err_chanoprivsneeded',
496
+      type: 'error'
497
+   },
498
+   483: {
499
+      name: 'err_cantkillserver',
500
+      type: 'error'
501
+   },
502
+   491: {
503
+      name: 'err_nooperhost',
504
+      type: 'error'
505
+   },
506
+   501: {
507
+      name: 'err_umodeunknownflag',
508
+      type: 'error'
509
+   },
510
+   502: {
511
+      name: 'err_usersdontmatch',
512
+      type: 'error'
513
+   }
514
+};
... ...
@@ -0,0 +1,33 @@
1
+var codes = {
2
+    white: '\u000300',
3
+    black: '\u000301',
4
+    dark_blue: '\u000302',
5
+    dark_green: '\u000303',
6
+    light_red: '\u000304',
7
+    dark_red: '\u000305',
8
+    magenta: '\u000306',
9
+    orange: '\u000307',
10
+    yellow: '\u000308',
11
+    light_green: '\u000309',
12
+    cyan: '\u000310',
13
+    light_cyan: '\u000311',
14
+    light_blue: '\u000312',
15
+    light_magenta: '\u000313',
16
+    gray: '\u000314',
17
+    light_gray: '\u000315',
18
+
19
+    bold: '\u0002',
20
+    underline: '\u001f',
21
+
22
+    reset: '\u000f'
23
+};
24
+exports.codes = codes;
25
+
26
+function wrap(color, text, resetColor) {
27
+    if (codes[color]) {
28
+        text = codes[color] + text;
29
+        text += (codes[resetColor]) ? codes[resetColor] : codes.reset;
30
+    }
31
+    return text;
32
+}
33
+exports.wrap = wrap;
... ...
@@ -0,0 +1,87 @@
1
+'use strict';
2
+
3
+var util = require('util');
4
+var EventEmitter = require('events').EventEmitter;
5
+
6
+/**
7
+ * This class encapsulates the ping timeout functionality. When enough
8
+ * silence (lack of server-sent activity) time passes, an object of this type
9
+ * will emit a 'wantPing' event, indicating you should send a PING message
10
+ * to the server in order to get some signs of life from it. If enough
11
+ * time passes after that (i.e. server does not respond to PING), then
12
+ * an object of this type will emit a 'pingTimeout' event.
13
+ *
14
+ * To start the gears turning, call start() on an instance of this class To
15
+ * put it in the 'started' state.
16
+ *
17
+ * When server-side activity occurs, call notifyOfActivity() on the object.
18
+ *
19
+ * When a pingTimeout occurs, the object will go into the 'stopped' state.
20
+ */
21
+var ctr = 0;
22
+
23
+function CyclingPingTimer(client) {
24
+    var timerNumber = ctr++;
25
+    var started = false;
26
+    var self = this;
27
+
28
+    // Only one of these two should be non-null at any given time.
29
+    var loopingTimeout = null;
30
+    var pingWaitTimeout = null;
31
+
32
+    // conditionally log debug messages
33
+    function debug(msg) {
34
+        if (client.opt.debug) {
35
+            console.error('CyclingPingTimer ' + timerNumber + ': ' + msg);
36
+        }
37
+    }
38
+
39
+    // set up EventEmitter functionality
40
+    EventEmitter.call(self);
41
+
42
+    self.on('wantPing', function() {
43
+        debug('server silent for too long, let\'s send a PING');
44
+        pingWaitTimeout = setTimeout(function() {
45
+            self.stop();
46
+            debug('ping timeout!');
47
+            self.emit('pingTimeout');
48
+        }, client.opt.millisecondsBeforePingTimeout);
49
+    });
50
+
51
+    self.notifyOfActivity = function() {
52
+        if (started) {
53
+            self.stop();
54
+            self.start();
55
+        }
56
+    };
57
+
58
+    self.stop = function() {
59
+        if (!started) {
60
+            return;
61
+        }
62
+        started = false;
63
+
64
+        clearTimeout(loopingTimeout);
65
+        clearTimeout(pingWaitTimeout);
66
+
67
+        loopingTimeout = null;
68
+        pingWaitTimeout = null;
69
+    };
70
+
71
+    self.start = function() {
72
+        if (started) {
73
+            debug('can\'t start, not stopped!');
74
+            return;
75
+        }
76
+        started = true;
77
+
78
+        loopingTimeout = setTimeout(function() {
79
+            loopingTimeout = null;
80
+            self.emit('wantPing');
81
+        }, client.opt.millisecondsOfSilenceBeforePingSent);
82
+    };
83
+}
84
+
85
+util.inherits(CyclingPingTimer, EventEmitter);
86
+
87
+module.exports = CyclingPingTimer;
... ...
@@ -0,0 +1,1162 @@
1
+/*
2
+    irc.js - Node JS IRC client library
3
+
4
+    (C) Copyright Martyn Smith 2010
5
+
6
+    This library is free software: you can redistribute it and/or modify
7
+    it under the terms of the GNU General Public License as published by
8
+    the Free Software Foundation, either version 3 of the License, or
9
+    (at your option) any later version.
10
+
11
+    This library is distributed in the hope that it will be useful,
12
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
13
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
+    GNU General Public License for more details.
15
+
16
+    You should have received a copy of the GNU General Public License
17
+    along with this library.  If not, see <http://www.gnu.org/licenses/>.
18
+*/
19
+
20
+exports.Client = Client;
21
+var net  = require('net');
22
+var tls  = require('tls');
23
+var util = require('util');
24
+var EventEmitter = require('events').EventEmitter;
25
+
26
+var colors = require('./colors');
27
+var parseMessage = require('./parse_message');
28
+exports.colors = colors;
29
+var CyclingPingTimer = require('./cycling_ping_timer.js');
30
+
31
+var lineDelimiter = new RegExp('\r\n|\r|\n')
32
+
33
+function Client(server, nick, opt) {
34
+    var self = this;
35
+    self.opt = {
36
+        server: server,
37
+        nick: nick,
38
+        password: null,
39
+        userName: 'nodebot',
40
+        realName: 'nodeJS IRC client',
41
+        port: 6667,
42
+        localAddress: null,
43
+        debug: false,
44
+        showErrors: false,
45
+        autoRejoin: false,
46
+        autoConnect: true,
47
+        channels: [],
48
+        retryCount: null,
49
+        retryDelay: 2000,
50
+        secure: false,
51
+        selfSigned: false,
52
+        certExpired: false,
53
+        floodProtection: false,
54
+        floodProtectionDelay: 1000,
55
+        sasl: false,
56
+        stripColors: false,
57
+        channelPrefixes: '&#',
58
+        messageSplit: 512,
59
+        encoding: false,
60
+        webirc: {
61
+          pass: '',
62
+          ip: '',
63
+          host: ''
64
+        },
65
+        millisecondsOfSilenceBeforePingSent: 15 * 1000,
66
+        millisecondsBeforePingTimeout: 8 * 1000
67
+    };
68
+
69
+    // Features supported by the server
70
+    // (initial values are RFC 1459 defaults. Zeros signify
71
+    // no default or unlimited value)
72
+    self.supported = {
73
+        channel: {
74
+            idlength: [],
75
+            length: 200,
76
+            limit: [],
77
+            modes: { a: '', b: '', c: '', d: ''},
78
+            types: self.opt.channelPrefixes
79
+        },
80
+        kicklength: 0,
81
+        maxlist: [],
82
+        maxtargets: [],
83
+        modes: 3,
84
+        nicklength: 9,
85
+        topiclength: 0,
86
+        usermodes: ''
87
+    };
88
+
89
+    if (typeof arguments[2] == 'object') {
90
+        var keys = Object.keys(self.opt);
91
+        for (var i = 0; i < keys.length; i++) {
92
+            var k = keys[i];
93
+            if (arguments[2][k] !== undefined)
94
+                self.opt[k] = arguments[2][k];
95
+        }
96
+    }
97
+
98
+    if (self.opt.floodProtection) {
99
+        self.activateFloodProtection();
100
+    }
101
+
102
+    self.hostMask = '';
103
+
104
+    // TODO - fail if nick or server missing
105
+    // TODO - fail if username has a space in it
106
+    if (self.opt.autoConnect === true) {
107
+        self.connect();
108
+    }
109
+
110
+    self.addListener('raw', function(message) {
111
+        var channels = [],
112
+            channel,
113
+            nick,
114
+            from,
115
+            text,
116
+            to;
117
+
118
+        switch (message.command) {
119
+            case 'rpl_welcome':
120
+                // Set nick to whatever the server decided it really is
121
+                // (normally this is because you chose something too long and
122
+                // the server has shortened it
123
+                self.nick = message.args[0];
124
+                // Note our hostmask to use it in splitting long messages.
125
+                // We don't send our hostmask when issuing PRIVMSGs or NOTICEs,
126
+                // of course, but rather the servers on the other side will
127
+                // include it in messages and will truncate what we send if
128
+                // the string is too long. Therefore, we need to be considerate
129
+                // neighbors and truncate our messages accordingly.
130
+                var welcomeStringWords = message.args[1].split(/\s+/);
131
+                self.hostMask = welcomeStringWords[welcomeStringWords.length - 1];
132
+                self._updateMaxLineLength();
133
+                self.emit('registered', message);
134
+                self.whois(self.nick, function(args) {
135
+                    self.nick = args.nick;
136
+                    self.hostMask = args.user + '@' + args.host;
137
+                    self._updateMaxLineLength();
138
+                });
139
+                break;
140
+            case 'rpl_myinfo':
141
+                self.supported.usermodes = message.args[3];
142
+                break;
143
+            case 'rpl_isupport':
144
+                message.args.forEach(function(arg) {
145
+                    var match;
146
+                    match = arg.match(/([A-Z]+)=(.*)/);
147
+                    if (match) {
148
+                        var param = match[1];
149
+                        var value = match[2];
150
+                        switch (param) {
151
+                            case 'CHANLIMIT':
152
+                                value.split(',').forEach(function(val) {
153
+                                    val = val.split(':');
154
+                                    self.supported.channel.limit[val[0]] = parseInt(val[1]);
155
+                                });
156
+                                break;
157
+                            case 'CHANMODES':
158
+                                value = value.split(',');
159
+                                var type = ['a', 'b', 'c', 'd'];
160
+                                for (var i = 0; i < type.length; i++) {
161
+                                    self.supported.channel.modes[type[i]] += value[i];
162
+                                }
163
+                                break;
164
+                            case 'CHANTYPES':
165
+                                self.supported.channel.types = value;
166
+                                break;
167
+                            case 'CHANNELLEN':
168
+                                self.supported.channel.length = parseInt(value);
169
+                                break;
170
+                            case 'IDCHAN':
171
+                                value.split(',').forEach(function(val) {
172
+                                    val = val.split(':');
173
+                                    self.supported.channel.idlength[val[0]] = val[1];
174
+                                });
175
+                                break;
176
+                            case 'KICKLEN':
177
+                                self.supported.kicklength = value;
178
+                                break;
179
+                            case 'MAXLIST':
180
+                                value.split(',').forEach(function(val) {
181
+                                    val = val.split(':');
182
+                                    self.supported.maxlist[val[0]] = parseInt(val[1]);
183
+                                });
184
+                                break;
185
+                            case 'NICKLEN':
186
+                                self.supported.nicklength = parseInt(value);
187
+                                break;
188
+                            case 'PREFIX':
189
+                                match = value.match(/\((.*?)\)(.*)/);
190
+                                if (match) {
191
+                                    match[1] = match[1].split('');
192
+                                    match[2] = match[2].split('');
193
+                                    while (match[1].length) {
194
+                                        self.modeForPrefix[match[2][0]] = match[1][0];
195
+                                        self.supported.channel.modes.b += match[1][0];
196
+                                        self.prefixForMode[match[1].shift()] = match[2].shift();
197
+                                    }
198
+                                }
199
+                                break;
200
+                            case 'STATUSMSG':
201
+                                break;
202
+                            case 'TARGMAX':
203
+                                value.split(',').forEach(function(val) {
204
+                                    val = val.split(':');
205
+                                    val[1] = (!val[1]) ? 0 : parseInt(val[1]);
206
+                                    self.supported.maxtargets[val[0]] = val[1];
207
+                                });
208
+                                break;
209
+                            case 'TOPICLEN':
210
+                                self.supported.topiclength = parseInt(value);
211
+                                break;
212
+                        }
213
+                    }
214
+                });
215
+                break;
216
+            case 'rpl_yourhost':
217
+            case 'rpl_created':
218
+            case 'rpl_luserclient':
219
+            case 'rpl_luserop':
220
+            case 'rpl_luserchannels':
221
+            case 'rpl_luserme':
222
+            case 'rpl_localusers':
223
+            case 'rpl_globalusers':
224
+            case 'rpl_statsconn':
225
+            case 'rpl_luserunknown':
226
+            case '396':
227
+            case '042':
228
+                // Random welcome crap, ignoring
229
+                break;
230
+            case 'err_nicknameinuse':
231
+                if (typeof (self.opt.nickMod) == 'undefined')
232
+                    self.opt.nickMod = 0;
233
+                self.opt.nickMod++;
234
+                self.send('NICK', self.opt.nick + self.opt.nickMod);
235
+                self.nick = self.opt.nick + self.opt.nickMod;
236
+                self._updateMaxLineLength();
237
+                break;
238
+            case 'PING':
239
+                self.send('PONG', message.args[0]);
240
+                self.emit('ping', message.args[0]);
241
+                break;
242
+            case 'PONG':
243
+                self.emit('pong', message.args[0]);
244
+                break;
245
+            case 'NOTICE':
246
+                from = message.nick;
247
+                to = message.args[0];
248
+                if (!to) {
249
+                    to = null;
250
+                }
251
+                text = message.args[1] || '';
252
+                if (text[0] === '\u0001' && text.lastIndexOf('\u0001') > 0) {
253
+                    self._handleCTCP(from, to, text, 'notice', message);
254
+                    break;
255
+                }
256
+                self.emit('notice', from, to, text, message);
257
+
258
+                if (self.opt.debug && to == self.nick)
259
+                    util.log('GOT NOTICE from ' + (from ? '"' + from + '"' : 'the server') + ': "' + text + '"');
260
+                break;
261
+            case 'MODE':
262
+                if (self.opt.debug)
263
+                    util.log('MODE: ' + message.args[0] + ' sets mode: ' + message.args[1]);
264
+
265
+                channel = self.chanData(message.args[0]);
266
+                if (!channel) break;
267
+                var modeList = message.args[1].split('');
268
+                var adding = true;
269
+                var modeArgs = message.args.slice(2);
270
+                modeList.forEach(function(mode) {
271
+                    if (mode == '+') {
272
+                        adding = true;
273
+                        return;
274
+                    }
275
+                    if (mode == '-') {
276
+                        adding = false;
277
+                        return;
278
+                    }
279
+
280
+                    var eventName = (adding ? '+' : '-') + 'mode';
281
+                    var supported = self.supported.channel.modes;
282
+                    var modeArg;
283
+                    var chanModes = function(mode, param) {
284
+                        var arr = param && Array.isArray(param);
285
+                        if (adding) {
286
+                            if (channel.mode.indexOf(mode) == -1) {
287
+                                channel.mode += mode;
288
+                            }
289
+                            if (param === undefined) {
290
+                                channel.modeParams[mode] = [];
291
+                            } else if (arr) {
292
+                                channel.modeParams[mode] = channel.modeParams[mode] ?
293
+                                    channel.modeParams[mode].concat(param) : param;
294
+                            } else {
295
+                                channel.modeParams[mode] = [param];
296
+                            }
297
+                        } else {
298
+                            if (arr) {
299
+                                channel.modeParams[mode] = channel.modeParams[mode]
300
+                                    .filter(function(v) { return v !== param[0]; });
301
+                            }
302
+                            if (!arr || channel.modeParams[mode].length === 0) {
303
+                                channel.mode = channel.mode.replace(mode, '');
304
+                                delete channel.modeParams[mode];
305
+                            }
306
+                        }
307
+                    };
308
+                    if (mode in self.prefixForMode) {
309
+                        modeArg = modeArgs.shift();
310
+                        if (channel.users.hasOwnProperty(modeArg)) {
311
+                            if (adding) {
312
+                                if (channel.users[modeArg].indexOf(self.prefixForMode[mode]) === -1)
313
+                                    channel.users[modeArg] += self.prefixForMode[mode];
314
+                            } else channel.users[modeArg] = channel.users[modeArg].replace(self.prefixForMode[mode], '');
315
+                        }
316
+                        self.emit(eventName, message.args[0], message.nick, mode, modeArg, message);
317
+                    } else if (supported.a.indexOf(mode) !== -1) {
318
+                        modeArg = modeArgs.shift();
319
+                        chanModes(mode, [modeArg]);
320
+                        self.emit(eventName, message.args[0], message.nick, mode, modeArg, message);
321
+                    } else if (supported.b.indexOf(mode) !== -1) {
322
+                        modeArg = modeArgs.shift();
323
+                        chanModes(mode, modeArg);
324
+                        self.emit(eventName, message.args[0], message.nick, mode, modeArg, message);
325
+                    } else if (supported.c.indexOf(mode) !== -1) {
326
+                        if (adding) modeArg = modeArgs.shift();
327
+                        else modeArg = undefined;
328
+                        chanModes(mode, modeArg);
329
+                        self.emit(eventName, message.args[0], message.nick, mode, modeArg, message);
330
+                    } else if (supported.d.indexOf(mode) !== -1) {
331
+                        chanModes(mode);
332
+                        self.emit(eventName, message.args[0], message.nick, mode, undefined, message);
333
+                    }
334
+                });
335
+                break;
336
+            case 'NICK':
337
+                if (message.nick == self.nick) {
338
+                    // the user just changed their own nick
339
+                    self.nick = message.args[0];
340
+                    self._updateMaxLineLength();
341
+                }
342
+
343
+                if (self.opt.debug)
344
+                    util.log('NICK: ' + message.nick + ' changes nick to ' + message.args[0]);
345
+
346
+                channels = [];
347
+
348
+                // TODO better way of finding what channels a user is in?
349
+                Object.keys(self.chans).forEach(function(channame) {
350
+                    var channel = self.chans[channame];
351
+                    channel.users[message.args[0]] = channel.users[message.nick];
352
+                    delete channel.users[message.nick];
353
+                    channels.push(channame);
354
+                });
355
+
356
+                // old nick, new nick, channels
357
+                self.emit('nick', message.nick, message.args[0], channels, message);
358
+                break;
359
+            case 'rpl_motdstart':
360
+                self.motd = message.args[1] + '\n';
361
+                break;
362
+            case 'rpl_motd':
363
+                self.motd += message.args[1] + '\n';
364
+                break;
365
+            case 'rpl_endofmotd':
366
+            case 'err_nomotd':
367
+                self.motd += message.args[1] + '\n';
368
+                self.emit('motd', self.motd);
369
+                break;
370
+            case 'rpl_namreply':
371
+                channel = self.chanData(message.args[2]);
372
+                var users = message.args[3].trim().split(/ +/);
373
+                if (channel) {
374
+                    users.forEach(function(user) {
375
+                        var match = user.match(/^(.)(.*)$/);
376
+                        if (match) {
377
+                            if (match[1] in self.modeForPrefix) {
378
+                                channel.users[match[2]] = match[1];
379
+                            }
380
+                            else {
381
+                                channel.users[match[1] + match[2]] = '';
382
+                            }
383
+                        }
384
+                    });
385
+                }
386
+                break;
387
+            case 'rpl_endofnames':
388
+                channel = self.chanData(message.args[1]);
389
+                if (channel) {
390
+                    self.emit('names', message.args[1], channel.users);
391
+                    self.emit('names' + message.args[1], channel.users);
392
+                    self.send('MODE', message.args[1]);
393
+                }
394
+                break;
395
+            case 'rpl_topic':
396
+                channel = self.chanData(message.args[1]);
397
+                if (channel) {
398
+                    channel.topic = message.args[2];
399
+                }
400
+                break;
401
+            case 'rpl_away':
402
+                self._addWhoisData(message.args[1], 'away', message.args[2], true);
403
+                break;
404
+            case 'rpl_whoisuser':
405
+                self._addWhoisData(message.args[1], 'user', message.args[2]);
406
+                self._addWhoisData(message.args[1], 'host', message.args[3]);
407
+                self._addWhoisData(message.args[1], 'realname', message.args[5]);
408
+                break;
409
+            case 'rpl_whoisidle':
410
+                self._addWhoisData(message.args[1], 'idle', message.args[2]);
411
+                break;
412
+            case 'rpl_whoischannels':
413
+               // TODO - clean this up?
414
+                self._addWhoisData(message.args[1], 'channels', message.args[2].trim().split(/\s+/));
415
+                break;
416
+            case 'rpl_whoisserver':
417
+                self._addWhoisData(message.args[1], 'server', message.args[2]);
418
+                self._addWhoisData(message.args[1], 'serverinfo', message.args[3]);
419
+                break;
420
+            case 'rpl_whoisoperator':
421
+                self._addWhoisData(message.args[1], 'operator', message.args[2]);
422
+                break;
423
+            case '330': // rpl_whoisaccount?
424
+                self._addWhoisData(message.args[1], 'account', message.args[2]);
425
+                self._addWhoisData(message.args[1], 'accountinfo', message.args[3]);
426
+                break;
427
+            case 'rpl_endofwhois':
428
+                self.emit('whois', self._clearWhoisData(message.args[1]));
429
+                break;
430
+            case 'rpl_whoreply':
431
+                self._addWhoisData(message.args[5], 'user', message.args[2]);
432
+                self._addWhoisData(message.args[5], 'host', message.args[3]);
433
+                self._addWhoisData(message.args[5], 'server', message.args[4]);
434
+                self._addWhoisData(message.args[5], 'realname', /[0-9]+\s*(.+)/g.exec(message.args[7])[1]);
435
+                // emit right away because rpl_endofwho doesn't contain nick
436
+                self.emit('whois', self._clearWhoisData(message.args[5]));
437
+                break;
438
+            case 'rpl_liststart':
439
+                self.channellist = [];
440
+                self.emit('channellist_start');
441
+                break;
442
+            case 'rpl_list':
443
+                channel = {
444
+                    name: message.args[1],
445
+                    users: message.args[2],
446
+                    topic: message.args[3]
447
+                };
448
+                self.emit('channellist_item', channel);
449
+                self.channellist.push(channel);
450
+                break;
451
+            case 'rpl_listend':
452
+                self.emit('channellist', self.channellist);
453
+                break;
454
+            case 'rpl_topicwhotime':
455
+                channel = self.chanData(message.args[1]);
456
+                if (channel) {
457
+                    channel.topicBy = message.args[2];
458
+                    // channel, topic, nick
459
+                    self.emit('topic', message.args[1], channel.topic, channel.topicBy, message);
460
+                }
461
+                break;
462
+            case 'TOPIC':
463
+                // channel, topic, nick
464
+                self.emit('topic', message.args[0], message.args[1], message.nick, message);
465
+
466
+                channel = self.chanData(message.args[0]);
467
+                if (channel) {
468
+                    channel.topic = message.args[1];
469
+                    channel.topicBy = message.nick;
470
+                }
471
+                break;
472
+            case 'rpl_channelmodeis':
473
+                channel = self.chanData(message.args[1]);
474
+                if (channel) {
475
+                    channel.mode = message.args[2];
476
+                }
477
+                break;
478
+            case 'rpl_creationtime':
479
+                channel = self.chanData(message.args[1]);
480
+                if (channel) {
481
+                    channel.created = message.args[2];
482
+                }
483
+                break;
484
+            case 'JOIN':
485
+                // channel, who
486
+                if (self.nick == message.nick) {
487
+                    self.chanData(message.args[0], true);
488
+                }
489
+                else {
490
+                    channel = self.chanData(message.args[0]);
491
+                    if (channel && channel.users) {
492
+                        channel.users[message.nick] = '';
493
+                    }
494
+                }
495
+                self.emit('join', message.args[0], message.nick, message);
496
+                self.emit('join' + message.args[0], message.nick, message);
497
+                if (message.args[0] != message.args[0].toLowerCase()) {
498
+                    self.emit('join' + message.args[0].toLowerCase(), message.nick, message);
499
+                }
500
+                break;
501
+            case 'PART':
502
+                // channel, who, reason
503
+                self.emit('part', message.args[0], message.nick, message.args[1], message);
504
+                self.emit('part' + message.args[0], message.nick, message.args[1], message);
505
+                if (message.args[0] != message.args[0].toLowerCase()) {
506
+                    self.emit('part' + message.args[0].toLowerCase(), message.nick, message.args[1], message);
507
+                }
508
+                if (self.nick == message.nick) {
509
+                    channel = self.chanData(message.args[0]);
510
+                    delete self.chans[channel.key];
511
+                }
512
+                else {
513
+                    channel = self.chanData(message.args[0]);
514
+                    if (channel && channel.users) {
515
+                        delete channel.users[message.nick];
516
+                    }
517
+                }
518
+                break;
519
+            case 'KICK':
520
+                // channel, who, by, reason
521
+                self.emit('kick', message.args[0], message.args[1], message.nick, message.args[2], message);
522
+                self.emit('kick' + message.args[0], message.args[1], message.nick, message.args[2], message);
523
+                if (message.args[0] != message.args[0].toLowerCase()) {
524
+                    self.emit('kick' + message.args[0].toLowerCase(),
525
+                              message.args[1], message.nick, message.args[2], message);
526
+                }
527
+
528
+                if (self.nick == message.args[1]) {
529
+                    channel = self.chanData(message.args[0]);
530
+                    delete self.chans[channel.key];
531
+                }
532
+                else {
533
+                    channel = self.chanData(message.args[0]);
534
+                    if (channel && channel.users) {
535
+                        delete channel.users[message.args[1]];
536
+                    }
537
+                }
538
+                break;
539
+            case 'KILL':
540
+                nick = message.args[0];
541
+                channels = [];
542
+                Object.keys(self.chans).forEach(function(channame) {
543
+                    var channel = self.chans[channame];
544
+                    channels.push(channame);
545
+                    delete channel.users[nick];
546
+                });
547
+                self.emit('kill', nick, message.args[1], channels, message);
548
+                break;
549
+            case 'PRIVMSG':
550
+                from = message.nick;
551
+                to = message.args[0];
552
+                text = message.args[1] || '';
553
+                if (text[0] === '\u0001' && text.lastIndexOf('\u0001') > 0) {
554
+                    self._handleCTCP(from, to, text, 'privmsg', message);
555
+                    break;
556
+                }
557
+                self.emit('message', from, to, text, message);
558
+                if (self.supported.channel.types.indexOf(to.charAt(0)) !== -1) {
559
+                    self.emit('message#', from, to, text, message);
560
+                    self.emit('message' + to, from, text, message);
561
+                    if (to != to.toLowerCase()) {
562
+                        self.emit('message' + to.toLowerCase(), from, text, message);
563
+                    }
564
+                }
565
+                if (to.toUpperCase() === self.nick.toUpperCase()) self.emit('pm', from, text, message);
566
+
567
+                if (self.opt.debug && to == self.nick)
568
+                    util.log('GOT MESSAGE from ' + from + ': ' + text);
569
+                break;
570
+            case 'INVITE':
571
+                from = message.nick;
572
+                to = message.args[0];
573
+                channel = message.args[1];
574
+                self.emit('invite', channel, from, message);
575
+                break;
576
+            case 'QUIT':
577
+                if (self.opt.debug)
578
+                    util.log('QUIT: ' + message.prefix + ' ' + message.args.join(' '));
579
+                if (self.nick == message.nick) {
580
+                    // TODO handle?
581
+                    break;
582
+                }
583
+                // handle other people quitting
584
+
585
+                channels = [];
586
+
587
+                // TODO better way of finding what channels a user is in?
588
+                Object.keys(self.chans).forEach(function(channame) {
589
+                    var channel = self.chans[channame];
590
+                    delete channel.users[message.nick];
591
+                    channels.push(channame);
592
+                });
593
+
594
+                // who, reason, channels
595
+                self.emit('quit', message.nick, message.args[0], channels, message);
596
+                break;
597
+
598
+            // for sasl
599
+            case 'CAP':
600
+                if (message.args[0] === '*' &&
601
+                     message.args[1] === 'ACK' &&
602
+                     message.args[2] === 'sasl ') // there's a space after sasl
603
+                    self.send('AUTHENTICATE', 'PLAIN');
604
+                break;
605
+            case 'AUTHENTICATE':
606
+                if (message.args[0] === '+') self.send('AUTHENTICATE',
607
+                    new Buffer(
608
+                        self.opt.nick + '\0' +
609
+                        self.opt.userName + '\0' +
610
+                        self.opt.password
611
+                    ).toString('base64'));
612
+                break;
613
+            case '903':
614
+                self.send('CAP', 'END');
615
+                break;
616
+
617
+            case 'err_umodeunknownflag':
618
+                if (self.opt.showErrors)
619
+                    util.log('\u001b[01;31mERROR: ' + util.inspect(message) + '\u001b[0m');
620
+                break;
621
+
622
+            case 'err_erroneusnickname':
623
+                if (self.opt.showErrors)
624
+                    util.log('\u001b[01;31mERROR: ' + util.inspect(message) + '\u001b[0m');
625
+                self.emit('error', message);
626
+                break;
627
+
628
+            // Commands relating to OPER
629
+            case 'err_nooperhost':
630
+                if (self.opt.showErrors) {
631
+                    self.emit('error', message);
632
+                    if (self.opt.showErrors)
633
+                        util.log('\u001b[01;31mERROR: ' + util.inspect(message) + '\u001b[0m');
634
+                }
635
+                break;
636
+
637
+            case 'rpl_youreoper':
638
+                self.emit('opered');
639
+                break;
640
+
641
+            default:
642
+                if (message.commandType == 'error') {
643
+                    self.emit('error', message);
644
+                    if (self.opt.showErrors)
645
+                        util.log('\u001b[01;31mERROR: ' + util.inspect(message) + '\u001b[0m');
646
+                }
647
+                else {
648
+                    if (self.opt.debug)
649
+                        util.log('\u001b[01;31mUnhandled message: ' + util.inspect(message) + '\u001b[0m');
650
+                    break;
651
+                }
652
+        }
653
+    });
654
+
655
+    self.addListener('kick', function(channel, who, by, reason) {
656
+        if (self.opt.autoRejoin)
657
+            self.send.apply(self, ['JOIN'].concat(channel.split(' ')));
658
+    });
659
+    self.addListener('motd', function(motd) {
660
+        self.opt.channels.forEach(function(channel) {
661
+            self.send.apply(self, ['JOIN'].concat(channel.split(' ')));
662
+        });
663
+    });
664
+
665
+    EventEmitter.call(this);
666
+}
667
+util.inherits(Client, EventEmitter);
668
+
669
+Client.prototype.conn = null;
670
+Client.prototype.prefixForMode = {};
671
+Client.prototype.modeForPrefix = {};
672
+Client.prototype.chans = {};
673
+Client.prototype._whoisData = {};
674
+
675
+Client.prototype.connectionTimedOut = function(conn) {
676
+    var self = this;
677
+    if (conn !== self.conn) {
678
+        // Only care about a timeout event if it came from the connection
679
+        // that is most current.
680
+        return;
681
+    }
682
+    self.end();
683
+};
684
+
685
+(function() {
686
+    var pingCounter = 1;
687
+    Client.prototype.connectionWantsPing = function(conn) {
688
+        var self = this;
689
+        if (conn !== self.conn) {
690
+            // Only care about a wantPing event if it came from the connection
691
+            // that is most current.
692
+            return;
693
+        }
694
+        self.send('PING', (pingCounter++).toString());
695
+    };
696
+}());
697
+
698
+Client.prototype.chanData = function(name, create) {
699
+    var key = name.toLowerCase();
700
+    if (create) {
701
+        this.chans[key] = this.chans[key] || {
702
+            key: key,
703
+            serverName: name,
704
+            users: {},
705
+            modeParams: {},
706
+            mode: ''
707
+        };
708
+    }
709
+
710
+    return this.chans[key];
711
+};
712
+
713
+Client.prototype._connectionHandler = function() {
714
+    if (this.opt.webirc.ip && this.opt.webirc.pass && this.opt.webirc.host) {
715
+        this.send('WEBIRC', this.opt.webirc.pass, this.opt.userName, this.opt.webirc.host, this.opt.webirc.ip);
716
+    }
717
+    if (this.opt.sasl) {
718
+        // see http://ircv3.atheme.org/extensions/sasl-3.1
719
+        this.send('CAP REQ', 'sasl');
720
+    } else if (this.opt.password) {
721
+        this.send('PASS', this.opt.password);
722
+    }
723
+    if (this.opt.debug)
724
+        util.log('Sending irc NICK/USER');
725
+    this.send('NICK', this.opt.nick);
726
+    this.nick = this.opt.nick;
727
+    this._updateMaxLineLength();
728
+    this.send('USER', this.opt.userName, 8, '*', this.opt.realName);
729
+
730
+    this.conn.cyclingPingTimer.start();
731
+
732
+    this.emit('connect');
733
+};
734
+
735
+Client.prototype.connect = function(retryCount, callback) {
736
+    if (typeof (retryCount) === 'function') {
737
+        callback = retryCount;
738
+        retryCount = undefined;
739
+    }
740
+    retryCount = retryCount || 0;
741
+    if (typeof (callback) === 'function') {
742
+        this.once('registered', callback);
743
+    }
744
+    var self = this;
745
+    self.chans = {};
746
+
747
+    // socket opts
748
+    var connectionOpts = {
749
+        host: self.opt.server,
750
+        port: self.opt.port
751
+    };
752
+
753
+    // local address to bind to
754
+    if (self.opt.localAddress)
755
+        connectionOpts.localAddress = self.opt.localAddress;
756
+
757
+    // try to connect to the server
758
+    if (self.opt.secure) {
759
+        connectionOpts.rejectUnauthorized = !self.opt.selfSigned;
760
+
761
+        if (typeof self.opt.secure == 'object') {
762
+            // copy "secure" opts to options passed to connect()
763
+            for (var f in self.opt.secure) {
764
+                connectionOpts[f] = self.opt.secure[f];
765
+            }
766
+        }
767
+
768
+        self.conn = tls.connect(connectionOpts, function() {
769
+            // callback called only after successful socket connection
770
+            self.conn.connected = true;
771
+            if (self.conn.authorized ||
772
+                (self.opt.selfSigned &&
773
+                    (self.conn.authorizationError   === 'DEPTH_ZERO_SELF_SIGNED_CERT' ||
774
+                     self.conn.authorizationError === 'UNABLE_TO_VERIFY_LEAF_SIGNATURE' ||
775
+                     self.conn.authorizationError === 'SELF_SIGNED_CERT_IN_CHAIN')) ||
776
+                (self.opt.certExpired &&
777
+                 self.conn.authorizationError === 'CERT_HAS_EXPIRED')) {
778
+                // authorization successful
779
+
780
+                if (!self.opt.encoding) {
781
+                    self.conn.setEncoding('utf-8');
782
+                }
783
+
784
+                if (self.opt.certExpired &&
785
+                    self.conn.authorizationError === 'CERT_HAS_EXPIRED') {
786
+                    util.log('Connecting to server with expired certificate');
787
+                }
788
+
789
+                self._connectionHandler();
790
+            } else {
791
+                // authorization failed
792
+                util.log(self.conn.authorizationError);
793
+            }
794
+        });
795
+    } else {
796
+        self.conn = net.createConnection(connectionOpts, self._connectionHandler.bind(self));
797
+    }
798
+    self.conn.requestedDisconnect = false;
799
+    self.conn.setTimeout(0);
800
+
801
+    // Each connection gets its own CyclingPingTimer. The connection forwards the timer's 'timeout' and 'wantPing' events
802
+    // to the client object via calling the connectionTimedOut() and connectionWantsPing() functions.
803
+    //
804
+    // Since the client's "current connection" value changes over time because of retry functionality,
805
+    // the client should ignore timeout/wantPing events that come from old connections.
806
+    self.conn.cyclingPingTimer = new CyclingPingTimer(self);
807
+    (function(conn) {
808
+        conn.cyclingPingTimer.on('pingTimeout', function() {
809
+            self.connectionTimedOut(conn);
810
+        });
811
+        conn.cyclingPingTimer.on('wantPing', function() {
812
+            self.connectionWantsPing(conn);
813
+        });
814
+    }(self.conn));
815
+
816
+    if (!self.opt.encoding) {
817
+        self.conn.setEncoding('utf8');
818
+    }
819
+
820
+    var buffer = new Buffer('');
821
+
822
+    function handleData(chunk) {
823
+        self.conn.cyclingPingTimer.notifyOfActivity();
824
+
825
+        if (typeof (chunk) === 'string') {
826
+            buffer += chunk;
827
+        } else {
828
+            buffer = Buffer.concat([buffer, chunk]);
829
+        }
830
+
831
+        var lines = self.convertEncoding(buffer).toString().split(lineDelimiter);
832
+
833
+        if (lines.pop()) {
834
+            // if buffer is not ended with \r\n, there's more chunks.
835
+            return;
836
+        } else {
837
+            // else, initialize the buffer.
838
+            buffer = new Buffer('');
839
+        }
840
+
841
+        lines.forEach(function iterator(line) {
842
+            if (line.length) {
843
+                var message = parseMessage(line, self.opt.stripColors);
844
+
845
+                try {
846
+                    self.emit('raw', message);
847
+                } catch (err) {
848
+                    if (!self.conn.requestedDisconnect) {
849
+                        throw err;
850
+                    }
851
+                }
852
+            }
853
+        });
854
+    }
855
+
856
+    self.conn.addListener('data', handleData);
857
+    self.conn.addListener('end', function() {
858
+        if (self.opt.debug)
859
+            util.log('Connection got "end" event');
860
+    });
861
+    self.conn.addListener('close', function() {
862
+        if (self.opt.debug)
863
+            util.log('Connection got "close" event');
864
+
865
+        if (self.conn && self.conn.requestedDisconnect)
866
+            return;
867
+        if (self.opt.debug)
868
+            util.log('Disconnected: reconnecting');
869
+        if (self.opt.retryCount !== null && retryCount >= self.opt.retryCount) {
870
+            if (self.opt.debug) {
871
+                util.log('Maximum retry count (' + self.opt.retryCount + ') reached. Aborting');
872
+            }
873
+            self.emit('abort', self.opt.retryCount);
874
+            return;
875
+        }
876
+
877
+        if (self.opt.debug) {
878
+            util.log('Waiting ' + self.opt.retryDelay + 'ms before retrying');
879
+        }
880
+        setTimeout(function() {
881
+            self.connect(retryCount + 1);
882
+        }, self.opt.retryDelay);
883
+    });
884
+    self.conn.addListener('error', function(exception) {
885
+        self.emit('netError', exception);
886
+        if (self.opt.debug) {
887
+            util.log('Network error: ' + exception);
888
+        }
889
+    });
890
+};
891
+
892
+Client.prototype.end = function() {
893
+    if (this.conn) {
894
+        this.conn.cyclingPingTimer.stop();
895
+        this.conn.destroy();
896
+    }
897
+    this.conn = null;
898
+};
899
+
900
+Client.prototype.disconnect = function(message, callback) {
901
+    if (typeof (message) === 'function') {
902
+        callback = message;
903
+        message = undefined;
904
+    }
905
+    message = message || 'node-irc says goodbye';
906
+    var self = this;
907
+    if (self.conn.readyState == 'open') {
908
+        var sendFunction;
909
+        if (self.opt.floodProtection) {
910
+            sendFunction = self._sendImmediate;
911
+            self._clearCmdQueue();
912
+        } else {
913
+            sendFunction = self.send;
914
+        }
915
+        sendFunction.call(self, 'QUIT', message);
916
+    }
917
+    self.conn.requestedDisconnect = true;
918
+    if (typeof (callback) === 'function') {
919
+        self.conn.once('end', callback);
920
+    }
921
+    self.conn.end();
922
+};
923
+
924
+Client.prototype.send = function(command) {
925
+    var args = Array.prototype.slice.call(arguments);
926
+
927
+    // Note that the command arg is included in the args array as the first element
928
+
929
+    if (args[args.length - 1].match(/\s/) || args[args.length - 1].match(/^:/) || args[args.length - 1] === '') {
930
+        args[args.length - 1] = ':' + args[args.length - 1];
931
+    }
932
+
933
+    if (this.opt.debug)
934
+        util.log('SEND: ' + args.join(' '));
935
+
936
+    if (!this.conn.requestedDisconnect) {
937
+        this.conn.write(args.join(' ') + '\r\n');
938
+    }
939
+};
940
+
941
+Client.prototype.activateFloodProtection = function(interval) {
942
+
943
+    var cmdQueue = [],
944
+        safeInterval = interval || this.opt.floodProtectionDelay,
945
+        self = this,
946
+        origSend = this.send,
947
+        dequeue;
948
+
949
+    // Wrapper for the original function. Just put everything to on central
950
+    // queue.
951
+    this.send = function() {
952
+        cmdQueue.push(arguments);
953
+    };
954
+
955
+    this._sendImmediate = function() {
956
+        origSend.apply(self, arguments);
957
+    };
958
+
959
+    this._clearCmdQueue = function() {
960
+        cmdQueue = [];
961
+    };
962
+
963
+    dequeue = function() {
964
+        var args = cmdQueue.shift();
965
+        if (args) {
966
+            origSend.apply(self, args);
967
+        }
968
+    };
969
+
970
+    // Slowly unpack the queue without flooding.
971
+    setInterval(dequeue, safeInterval);
972
+    dequeue();
973
+};
974
+
975
+Client.prototype.join = function(channel, callback) {
976
+    var channelName =  channel.split(' ')[0];
977
+    this.once('join' + channelName, function() {
978
+        // if join is successful, add this channel to opts.channels
979
+        // so that it will be re-joined upon reconnect (as channels
980
+        // specified in options are)
981
+        if (this.opt.channels.indexOf(channel) == -1) {
982
+            this.opt.channels.push(channel);
983
+        }
984
+
985
+        if (typeof (callback) == 'function') {
986
+            return callback.apply(this, arguments);
987
+        }
988
+    });
989
+    this.send.apply(this, ['JOIN'].concat(channel.split(' ')));
990
+};
991
+
992
+Client.prototype.part = function(channel, message, callback) {
993
+    if (typeof (message) === 'function') {
994
+        callback = message;
995
+        message = undefined;
996
+    }
997
+    if (typeof (callback) == 'function') {
998
+        this.once('part' + channel, callback);
999
+    }
1000
+
1001
+    // remove this channel from this.opt.channels so we won't rejoin
1002
+    // upon reconnect
1003
+    if (this.opt.channels.indexOf(channel) != -1) {
1004
+        this.opt.channels.splice(this.opt.channels.indexOf(channel), 1);
1005
+    }
1006
+
1007
+    if (message) {
1008
+        this.send('PART', channel, message);
1009
+    } else {
1010
+        this.send('PART', channel);
1011
+    }
1012
+};
1013
+
1014
+Client.prototype.action = function(channel, text) {
1015
+    var self = this;
1016
+    if (typeof text !== 'undefined') {
1017
+        text.toString().split(/\r?\n/).filter(function(line) {
1018
+            return line.length > 0;
1019
+        }).forEach(function(line) {
1020
+            self.say(channel, '\u0001ACTION ' + line + '\u0001');
1021
+        });
1022
+    }
1023
+};
1024
+
1025
+Client.prototype._splitLongLines = function(words, maxLength, destination) {
1026
+    maxLength = maxLength || 450; // If maxLength hasn't been initialized yet, prefer an arbitrarily low line length over crashing.
1027
+    if (words.length == 0) {
1028
+        return destination;
1029
+    }
1030
+    if (words.length <= maxLength) {
1031
+        destination.push(words);
1032
+        return destination;
1033
+    }
1034
+    var c = words[maxLength];
1035
+    var cutPos;
1036
+    var wsLength = 1;
1037
+    if (c.match(/\s/)) {
1038
+        cutPos = maxLength;
1039
+    } else {
1040
+        var offset = 1;
1041
+        while ((maxLength - offset) > 0) {
1042
+            var c = words[maxLength - offset];
1043
+            if (c.match(/\s/)) {
1044
+                cutPos = maxLength - offset;
1045
+                break;
1046
+            }
1047
+            offset++;
1048
+        }
1049
+        if (maxLength - offset <= 0) {
1050
+            cutPos = maxLength;
1051
+            wsLength = 0;
1052
+        }
1053
+    }
1054
+    var part = words.substring(0, cutPos);
1055
+    destination.push(part);
1056
+    return this._splitLongLines(words.substring(cutPos + wsLength, words.length), maxLength, destination);
1057
+};
1058
+
1059
+Client.prototype.say = function(target, text) {
1060
+    this._speak('PRIVMSG', target, text);
1061
+};
1062
+
1063
+Client.prototype.notice = function(target, text) {
1064
+    this._speak('NOTICE', target, text);
1065
+};
1066
+
1067
+Client.prototype._speak = function(kind, target, text) {
1068
+    var self = this;
1069
+    var maxLength = Math.min(this.maxLineLength - target.length, this.opt.messageSplit);
1070
+    if (typeof text !== 'undefined') {
1071
+        text.toString().split(/\r?\n/).filter(function(line) {
1072
+            return line.length > 0;
1073
+        }).forEach(function(line) {
1074
+            var linesToSend = self._splitLongLines(line, maxLength, []);
1075
+            linesToSend.forEach(function(toSend) {
1076
+                self.send(kind, target, toSend);
1077
+                if (kind == 'PRIVMSG') {
1078
+                    self.emit('selfMessage', target, toSend);
1079
+                }
1080
+            });
1081
+        });
1082
+    }
1083
+};
1084
+
1085
+Client.prototype.whois = function(nick, callback) {
1086
+    if (typeof callback === 'function') {
1087
+        var callbackWrapper = function(info) {
1088
+            if (info.nick.toLowerCase() == nick.toLowerCase()) {
1089
+                this.removeListener('whois', callbackWrapper);
1090
+                return callback.apply(this, arguments);
1091
+            }
1092
+        };
1093
+        this.addListener('whois', callbackWrapper);
1094
+    }
1095
+    this.send('WHOIS', nick);
1096
+};
1097
+
1098
+Client.prototype.list = function() {
1099
+    var args = Array.prototype.slice.call(arguments, 0);
1100
+    args.unshift('LIST');
1101
+    this.send.apply(this, args);
1102
+};
1103
+
1104
+Client.prototype._addWhoisData = function(nick, key, value, onlyIfExists) {
1105
+    if (onlyIfExists && !this._whoisData[nick]) return;
1106
+    this._whoisData[nick] = this._whoisData[nick] || {nick: nick};
1107
+    this._whoisData[nick][key] = value;
1108
+};
1109
+
1110
+Client.prototype._clearWhoisData = function(nick) {
1111
+    // Ensure that at least the nick exists before trying to return
1112
+    this._addWhoisData(nick, 'nick', nick);
1113
+    var data = this._whoisData[nick];
1114
+    delete this._whoisData[nick];
1115
+    return data;
1116
+};
1117
+
1118
+Client.prototype._handleCTCP = function(from, to, text, type, message) {
1119
+    text = text.slice(1);
1120
+    text = text.slice(0, text.indexOf('\u0001'));
1121
+    var parts = text.split(' ');
1122
+    this.emit('ctcp', from, to, text, type, message);
1123
+    this.emit('ctcp-' + type, from, to, text, message);
1124
+    if (type === 'privmsg' && text === 'VERSION')
1125
+        this.emit('ctcp-version', from, to, message);
1126
+    if (parts[0] === 'ACTION' && parts.length > 1)
1127
+        this.emit('action', from, to, parts.slice(1).join(' '), message);
1128
+    if (parts[0] === 'PING' && type === 'privmsg' && parts.length > 1)
1129
+        this.ctcp(from, 'notice', text);
1130
+};
1131
+
1132
+Client.prototype.ctcp = function(to, type, text) {
1133
+    return this[type === 'privmsg' ? 'say' : 'notice'](to, '\u0001' + text + '\u0001');
1134
+};
1135
+
1136
+Client.prototype.convertEncoding = function(str) {
1137
+    var self = this, out = str;
1138
+
1139
+    if (self.opt.encoding) {
1140
+        try {
1141
+            var charsetDetector = require('node-icu-charset-detector');
1142
+            var Iconv = require('iconv').Iconv;
1143
+            var charset = charsetDetector.detectCharset(str);
1144
+            var converter = new Iconv(charset.toString(), self.opt.encoding);
1145
+
1146
+            out = converter.convert(str);
1147
+        } catch (err) {
1148
+            if (self.opt.debug) {
1149
+                util.log('\u001b[01;31mERROR: ' + err + '\u001b[0m');
1150
+                util.inspect({ str: str, charset: charset });
1151
+            }
1152
+        }
1153
+    }
1154
+
1155
+    return out;
1156
+};
1157
+// blatantly stolen from irssi's splitlong.pl. Thanks, Bjoern Krombholz!
1158
+Client.prototype._updateMaxLineLength = function() {
1159
+    // 497 = 510 - (":" + "!" + " PRIVMSG " + " :").length;
1160
+    // target is determined in _speak() and subtracted there
1161
+    this.maxLineLength = 497 - this.nick.length - this.hostMask.length;
1162
+};
... ...
@@ -0,0 +1,69 @@
1
+var ircColors = require('irc-colors');
2
+var replyFor = require('./codes');
3
+
4
+/**
5
+ * parseMessage(line, stripColors)
6
+ *
7
+ * takes a raw "line" from the IRC server and turns it into an object with
8
+ * useful keys
9
+ * @param {String} line Raw message from IRC server.
10
+ * @param {Boolean} stripColors If true, strip IRC colors.
11
+ * @return {Object} A parsed message object.
12
+ */
13
+module.exports = function parseMessage(line, stripColors) {
14
+    var message = {};
15
+    var match;
16
+
17
+    if (stripColors) {
18
+        line = ircColors.stripColorsAndStyle(line);
19
+    }
20
+
21
+    // Parse prefix
22
+    match = line.match(/^:([^ ]+) +/);
23
+    if (match) {
24
+        message.prefix = match[1];
25
+        line = line.replace(/^:[^ ]+ +/, '');
26
+        match = message.prefix.match(/^([_a-zA-Z0-9\~\[\]\\`^{}|-]*)(!([^@]+)@(.*))?$/);
27
+        if (match) {
28
+            message.nick = match[1];
29
+            message.user = match[3];
30
+            message.host = match[4];
31
+        }
32
+        else {
33
+            message.server = message.prefix;
34
+        }
35
+    }
36
+
37
+    // Parse command
38
+    match = line.match(/^([^ ]+) */);
39
+    message.command = match[1];
40
+    message.rawCommand = match[1];
41
+    message.commandType = 'normal';
42
+    line = line.replace(/^[^ ]+ +/, '');
43
+
44
+    if (replyFor[message.rawCommand]) {
45
+        message.command     = replyFor[message.rawCommand].name;
46
+        message.commandType = replyFor[message.rawCommand].type;
47
+    }
48
+
49
+    message.args = [];
50
+    var middle, trailing;
51
+
52
+    // Parse parameters
53
+    if (line.search(/^:|\s+:/) != -1) {
54
+        match = line.match(/(.*?)(?:^:|\s+:)(.*)/);
55
+        middle = match[1].trimRight();
56
+        trailing = match[2];
57
+    }
58
+    else {
59
+        middle = line;
60
+    }
61
+
62
+    if (middle.length)
63
+        message.args = middle.split(/ +/);
64
+
65
+    if (typeof (trailing) != 'undefined' && trailing.length)
66
+        message.args.push(trailing);
67
+
68
+    return message;
69
+}
... ...
@@ -0,0 +1,46 @@
1
+{
2
+  "name": "irc",
3
+  "description": "An IRC client library for node",
4
+  "version": "0.5.2",
5
+  "author": "Martyn Smith <martyn@dollyfish.net.nz>",
6
+  "scripts": {
7
+    "test": "./node_modules/faucet/bin/cmd.js test/test-*.js",
8
+    "lint": "./node_modules/jscs/bin/jscs --preset=airbnb */*.js"
9
+  },
10
+  "contributors": [
11
+    "Fionn Kelleher <me@fionn.co>",
12
+    "xAndy <xandy@hackerspace-bamberg.de>",
13
+    "Mischa Spiegelmock <revmischa@cpan.org>",
14
+    "Justin Gallardo <justin.gallardo@gmail.com>",
15
+    "Chris Nehren <cnehren@pobox.com>",
16
+    "Henri Niemeläinen <aivot-on@iki.fi>",
17
+    "Alex Miles <ghostaldev@gmail.com>",
18
+    "Simmo Saan <simmo.saan@gmail.com>"
19
+  ],
20
+  "repository": {
21
+    "type": "git",
22
+    "url": "http://github.com/martynsmith/node-irc"
23
+  },
24
+  "bugs": {
25
+    "mail": "martyn@dollyfish.net.nz",
26
+    "url": "http://github.com/martynsmith/node-irc/issues"
27
+  },
28
+  "main": "lib/irc",
29
+  "engines": {
30
+    "node": ">=0.10.0"
31
+  },
32
+  "license": "GPL-3.0",
33
+  "dependencies": {
34
+    "irc-colors": "^1.1.0"
35
+  },
36
+  "optionalDependencies": {
37
+    "iconv": "~2.2.1",
38
+    "node-icu-charset-detector": "~0.2.0"
39
+  },
40
+  "devDependencies": {
41
+    "ansi-color": "0.2.1",
42
+    "faucet": "0.0.1",
43
+    "jscs": "1.9.0",
44
+    "tape": "^3.0.3"
45
+  }
46
+}
... ...
@@ -0,0 +1,29 @@
1
+#!/usr/bin/env node
2
+
3
+var irc  = require('./lib/irc.js');
4
+var util = require('util');
5
+var color = require('ansi-color').set;
6
+
7
+var c = new irc.Client(
8
+    'irc.dollyfish.net.nz',
9
+    'nodebot',
10
+    {
11
+        channels: ['#test'],
12
+        //debug: true
13
+    }
14
+);
15
+
16
+c.addListener('raw', function(message) { console.log('raw: ', message) });
17
+c.addListener('error', function(message) { console.log(color('error: ', 'red'), message) });
18
+
19
+var repl = require('repl').start('> ');
20
+repl.context.repl = repl;
21
+repl.context.util = util;
22
+repl.context.irc = irc;
23
+repl.context.c = c;
24
+
25
+repl.inputStream.addListener('close', function() {
26
+    console.log("\nClosing session");
27
+    c.disconnect('Closing session');
28
+});
29
+
... ...
@@ -0,0 +1,197 @@
1
+{
2
+	"basic": {
3
+		"sent": [
4
+			["NICK testbot", "Client sent NICK message"],
5
+			["USER nodebot 8 * :nodeJS IRC client", "Client sent USER message"],
6
+			["QUIT :node-irc says goodbye", "Client sent QUIT message"]
7
+		],
8
+
9
+		"received": [
10
+			[":localhost 001 testbot :Welcome to the Internet Relay Chat Network testbot\r\n", "Received welcome message"]
11
+		]
12
+	},
13
+	"double-CRLF": {
14
+		"sent": [
15
+			["NICK testbot", "Client sent NICK message"],
16
+			["USER nodebot 8 * :nodeJS IRC client", "Client sent USER message"],
17
+			["QUIT :node-irc says goodbye", "Client sent QUIT message"]
18
+		],
19
+
20
+		"received": [
21
+			[":localhost 001 testbot :Welcome to the Internet Relay Chat Network testbot\r\n\r\n", "Received welcome message"]
22
+		]
23
+	},
24
+	"parse-line": {
25
+		":irc.dollyfish.net.nz 372 nodebot :The message of the day was last changed: 2012-6-16 23:57": {
26
+			"prefix": "irc.dollyfish.net.nz",
27
+			"server": "irc.dollyfish.net.nz",
28
+			"command": "rpl_motd",
29
+			"rawCommand": "372",
30
+			"commandType": "reply",
31
+			"args": ["nodebot", "The message of the day was last changed: 2012-6-16 23:57"]
32
+		},
33
+		":Ned!~martyn@irc.dollyfish.net.nz PRIVMSG #test :Hello nodebot!": {
34
+			"prefix": "Ned!~martyn@irc.dollyfish.net.nz",
35
+			"nick": "Ned",
36
+			"user": "~martyn",
37
+			"host": "irc.dollyfish.net.nz",
38
+			"command": "PRIVMSG",
39
+			"rawCommand": "PRIVMSG",
40
+			"commandType": "normal",
41
+			"args": ["#test", "Hello nodebot!"]
42
+		},
43
+		":Ned!~martyn@irc.dollyfish.net.nz PRIVMSG #test ::-)": {
44
+			"prefix": "Ned!~martyn@irc.dollyfish.net.nz",
45
+			"nick": "Ned",
46
+			"user": "~martyn",
47
+			"host": "irc.dollyfish.net.nz",
48
+			"command": "PRIVMSG",
49
+			"rawCommand": "PRIVMSG",
50
+			"commandType": "normal",
51
+			"args": ["#test", ":-)"]
52
+		},
53
+		":Ned!~martyn@irc.dollyfish.net.nz PRIVMSG #test ::": {
54
+			"prefix": "Ned!~martyn@irc.dollyfish.net.nz",
55
+			"nick": "Ned",
56
+			"user": "~martyn",
57
+			"host": "irc.dollyfish.net.nz",
58
+			"command": "PRIVMSG",
59
+			"rawCommand": "PRIVMSG",
60
+			"commandType": "normal",
61
+			"args": ["#test", ":"]
62
+		},
63
+		":Ned!~martyn@irc.dollyfish.net.nz PRIVMSG #test ::^:^:": {
64
+			"prefix": "Ned!~martyn@irc.dollyfish.net.nz",
65
+			"nick": "Ned",
66
+			"user": "~martyn",
67
+			"host": "irc.dollyfish.net.nz",
68
+			"command": "PRIVMSG",
69
+			"rawCommand": "PRIVMSG",
70
+			"commandType": "normal",
71
+			"args": ["#test", ":^:^:"]
72
+		},
73
+		":some.irc.net 324 webuser #channel +Cnj 5:10": {
74
+			"prefix": "some.irc.net",
75
+			"server": "some.irc.net",
76
+			"command": "rpl_channelmodeis",
77
+			"rawCommand": "324",
78
+			"commandType": "reply",
79
+			"args": ["webuser", "#channel", "+Cnj", "5:10"]
80
+		},
81
+		":nick!user@host QUIT :Ping timeout: 252 seconds": {
82
+			"prefix": "nick!user@host",
83
+			"nick": "nick",
84
+			"user": "user",
85
+			"host": "host",
86
+			"command": "QUIT",
87
+			"rawCommand": "QUIT",
88
+			"commandType": "normal",
89
+			"args": ["Ping timeout: 252 seconds"]
90
+		},
91
+		":nick!user@host PRIVMSG #channel :so : colons: :are :: not a problem ::::": {
92
+			"prefix": "nick!user@host",
93
+			"nick": "nick",
94
+			"user": "user",
95
+			"host": "host",
96
+			"command": "PRIVMSG",
97
+			"rawCommand": "PRIVMSG",
98
+			"commandType": "normal",
99
+			"args": ["#channel", "so : colons: :are :: not a problem ::::"]
100
+		},
101
+		":nick!user@host PRIVMSG #channel :\u000314,01\u001fneither are colors or styles\u001f\u0003": {
102
+			"prefix": "nick!user@host",
103
+			"nick": "nick",
104
+			"user": "user",
105
+			"host": "host",
106
+			"command": "PRIVMSG",
107
+			"rawCommand": "PRIVMSG",
108
+			"commandType": "normal",
109
+			"args": ["#channel", "neither are colors or styles"],
110
+			"stripColors": true
111
+		},
112
+		":nick!user@host PRIVMSG #channel :\u000314,01\u001fwe can leave styles and colors alone if desired\u001f\u0003": {
113
+			"prefix": "nick!user@host",
114
+			"nick": "nick",
115
+			"user": "user",
116
+			"host": "host",
117
+			"command": "PRIVMSG",
118
+			"rawCommand": "PRIVMSG",
119
+			"commandType": "normal",
120
+			"args": ["#channel", "\u000314,01\u001fwe can leave styles and colors alone if desired\u001f\u0003"],
121
+			"stripColors": false
122
+		},
123
+		":pratchett.freenode.net 324 nodebot #ubuntu +CLcntjf 5:10 #ubuntu-unregged": {
124
+			"prefix": "pratchett.freenode.net",
125
+			"server": "pratchett.freenode.net",
126
+			"command": "rpl_channelmodeis",
127
+			"rawCommand": "324",
128
+			"commandType": "reply",
129
+			"args": ["nodebot", "#ubuntu", "+CLcntjf", "5:10", "#ubuntu-unregged"]
130
+		}
131
+
132
+	},
133
+	"433-before-001": {
134
+		"sent": [
135
+			["NICK testbot", "Client sent NICK message"],
136
+			["USER nodebot 8 * :nodeJS IRC client", "Client sent USER message"],
137
+			["NICK testbot1", "Client sent proper response to 433 nickname in use message"],
138
+			["QUIT :node-irc says goodbye", "Client sent QUIT message"]
139
+		],
140
+
141
+		"received": [
142
+			[":localhost 433 * testbot :Nickname is already in use.\r\n", "Received nick in use error"],
143
+			[":localhost 001 testbot1 :Welcome to the Internet Relay Chat Network testbot\r\n", "Received welcome message"]
144
+		],
145
+		"clientInfo": [
146
+			"hostmask is as expected after 433",
147
+			"nick is as expected after 433",
148
+			"maxLineLength is as expected after 433"
149
+		]
150
+	},
151
+    "convert-encoding": {
152
+        "causesException": [
153
+            ":ubottu!ubottu@ubuntu/bot/ubottu MODE #ubuntu -bo *!~Brian@* ubottu\r\n",
154
+            "Elizabeth",
155
+            ":sblack1!~sblack1@unaffiliated/sblack1 NICK :sblack\r\n",
156
+            ":TijG!~TijG@null.1ago.be PRIVMSG #ubuntu :ThinkPad\r\n"
157
+        ]
158
+    },
159
+    "_splitLongLines": [
160
+        {
161
+            "input": "abcde ",
162
+            "maxLength": 5,
163
+            "result": ["abcde"]
164
+        },
165
+        {
166
+            "input": "abcde",
167
+            "maxLength": 5,
168
+            "result": ["abcde"]
169
+        },
170
+        {
171
+            "input": "abcdefghijklmnopqrstuvwxyz",
172
+            "maxLength": 5,
173
+            "result": ["abcde", "fghij", "klmno", "pqrst", "uvwxy", "z"]
174
+        },
175
+        {
176
+            "input": "abc abcdef abc abcd abc",
177
+            "maxLength": 5,
178
+            "result": ["abc", "abcde", "f abc", "abcd", "abc"]
179
+        }
180
+    ],
181
+	"_splitLongLines_no_max": [
182
+		{
183
+			"input": "abcdefghijklmnopqrstuvwxyz",
184
+			"result": ["abcdefghijklmnopqrstuvwxyz"]
185
+		}
186
+	],
187
+	"_speak": [
188
+		{
189
+			"length": 30,
190
+			"expected": 10
191
+		},
192
+		{
193
+			"length": 7,
194
+			"expected": 1
195
+		}
196
+	]
197
+}
... ...
@@ -0,0 +1,15 @@
1
+-----BEGIN RSA PRIVATE KEY-----
2
+MIICWwIBAAKBgQDH5pYbcECKUrbRbUXKUu7lMCgb9UkPi4+Ur9f0LYdspHZJlv0S
3
+yBn4RpJOl8EsMhWI+houY3mBlcCL/DwiGfMDk5TSomyrI6eONFworokTJpG2h0f0
4
+cWnGdDW1zu8Z1odo047NWzwwv2mU03fkZmzfCclAzjKkDMMqP34mPl5TnwIDAQAB
5
+AoGAJslK3tAM9cnOxxvYqsUkrTuGzMXvAyElHshvsmUTHbVbbjPprrc8sruer7kq
6
+NhURsJ42bkHG1ankzkSGtmcqi3LdBBhVLm5gyog2JxQlTxvUVOPvyrOsQkl3uDwL
7
+aZqGTESHlLx7jhOKgiImqo0uGxNy46tzsHbpFGAeqTYcYKECQQD6faxqytMpMc/h
8
+zcrWsRhe7Omj5D6VdrbkGkM8razn4Oyr42p8Xylcde2MlnTiTAL5ElxlLd4PYsLD
9
+hKme/M5tAkEAzEwT1GU7CYjPdHHfsHUbDIHBh0BOJje2TXhDOa5tiZbOZevIk6TZ
10
+V6p/9zjLe5RAc/dpzHv1C+vQOkhgvoNyuwJARwjGkU5NTXxTwGwUnoeAKsMyioia
11
+etY8jTkpYha6VtOBKkmGlBiEaTUEFX9BTD9UBIABdavpMiHGq51+YJi+jQJAGYic
12
+pdwtH8jwnM4qtgQ86DhDduMLoW0vJMmWJVxuplap30Uz4XgmDfXqXnzDueNSluvi
13
+VkNb4iyL7uzi4ozNRwJALT0vP65RQ2d7OUEwB4XZFExKYzHADiFtw0NZtcWRW6y3
14
+rN0uXMxEZ6vRQurVjO9GhB76fAo/UooX0MVF0ShFNQ==
15
+-----END RSA PRIVATE KEY-----
... ...
@@ -0,0 +1,17 @@
1
+-----BEGIN CERTIFICATE-----
2
+MIICojCCAgugAwIBAgIJAMid3M25tUeUMA0GCSqGSIb3DQEBBQUAMGoxCzAJBgNV
3
+BAYTAlpaMREwDwYDVQQIDAhJbnRlcm5ldDEPMA0GA1UEBwwGZ2l0aHViMREwDwYD
4
+VQQKDAhub2RlLWlyYzEQMA4GA1UECwwHdGVzdGluZzESMBAGA1UEAwwJbG9jYWxo
5
+b3N0MB4XDTE1MDExMjIzNDg0MloXDTI1MDEwOTIzNDg0MlowajELMAkGA1UEBhMC
6
+WloxETAPBgNVBAgMCEludGVybmV0MQ8wDQYDVQQHDAZnaXRodWIxETAPBgNVBAoM
7
+CG5vZGUtaXJjMRAwDgYDVQQLDAd0ZXN0aW5nMRIwEAYDVQQDDAlsb2NhbGhvc3Qw
8
+gZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMfmlhtwQIpSttFtRcpS7uUwKBv1
9
+SQ+Lj5Sv1/Qth2ykdkmW/RLIGfhGkk6XwSwyFYj6Gi5jeYGVwIv8PCIZ8wOTlNKi
10
+bKsjp440XCiuiRMmkbaHR/RxacZ0NbXO7xnWh2jTjs1bPDC/aZTTd+RmbN8JyUDO
11
+MqQMwyo/fiY+XlOfAgMBAAGjUDBOMB0GA1UdDgQWBBTUaumzrTJrl1goRRzOGgEO
12
+VNKFmjAfBgNVHSMEGDAWgBTUaumzrTJrl1goRRzOGgEOVNKFmjAMBgNVHRMEBTAD
13
+AQH/MA0GCSqGSIb3DQEBBQUAA4GBAGKppBE9mjk2zJPSxPcHl3RSpnPs5ZkuBLnK
14
+rxZ2bR9VJhoQEwtiZRxkSXSdooj3eJgzMobYMEhSvFibUeBuIppB7oacys2Bd+O1
15
+xzILcbgEPqsk5JFbYT9KD8r+sZy5Wa1A39eNkmdD/oWt9Mb1PLrDfM/melvZ9/vW
16
+oMSmMipK
17
+-----END CERTIFICATE-----
... ...
@@ -0,0 +1,69 @@
1
+/* Mock irc server */
2
+
3
+var path = require('path');
4
+var fs = require('fs');
5
+var net = require('net');
6
+var tls = require('tls');
7
+var util = require('util');
8
+var EventEmitter = require('events').EventEmitter;
9
+
10
+var MockIrcd = function(port, encoding, isSecure) {
11
+    var self = this;
12
+    var connectionClass;
13
+    var options = {};
14
+
15
+    if (isSecure) {
16
+        connectionClass = tls;
17
+        options = {
18
+            key: fs.readFileSync(path.resolve(__dirname, 'data/ircd.key')),
19
+            cert: fs.readFileSync(path.resolve(__dirname, 'data/ircd.pem'))
20
+        };
21
+    } else {
22
+        connectionClass = net;
23
+    }
24
+
25
+    this.port = port || (isSecure ? 6697 : 6667);
26
+    this.encoding = encoding || 'utf-8';
27
+    this.incoming = [];
28
+    this.outgoing = [];
29
+
30
+    this.server = connectionClass.createServer(options, function(c) {
31
+        c.on('data', function(data) {
32
+            var msg = data.toString(self.encoding).split('\r\n').filter(function(m) { return m; });
33
+            self.incoming = self.incoming.concat(msg);
34
+        });
35
+
36
+        self.on('send', function(data) {
37
+            self.outgoing.push(data);
38
+            c.write(data);
39
+        });
40
+
41
+        c.on('end', function() {
42
+            self.emit('end');
43
+        });
44
+    });
45
+
46
+    this.server.listen(this.port);
47
+};
48
+util.inherits(MockIrcd, EventEmitter);
49
+
50
+MockIrcd.prototype.send = function(data) {
51
+    this.emit('send', data);
52
+};
53
+
54
+MockIrcd.prototype.close = function() {
55
+    this.server.close();
56
+};
57
+
58
+MockIrcd.prototype.getIncomingMsgs = function() {
59
+    return this.incoming;
60
+};
61
+
62
+var fixtures = require('./data/fixtures');
63
+module.exports.getFixtures = function(testSuite) {
64
+    return fixtures[testSuite];
65
+};
66
+
67
+module.exports.MockIrcd = function(port, encoding, isSecure) {
68
+    return new MockIrcd(port, encoding, isSecure);
69
+};
... ...
@@ -0,0 +1,39 @@
1
+var irc = require('../lib/irc');
2
+var test = require('tape');
3
+
4
+var testHelpers = require('./helpers');
5
+
6
+test('connect and sets hostmask when nick in use', function(t) {
7
+    var client, mock, expected;
8
+
9
+    mock = testHelpers.MockIrcd();
10
+    client = new irc.Client('localhost', 'testbot', {debug: true});
11
+
12
+    expected = testHelpers.getFixtures('433-before-001');
13
+
14
+    t.plan(expected.sent.length + expected.received.length + expected.clientInfo.length);
15
+
16
+    mock.server.on('connection', function() {
17
+        mock.send(':localhost 433 * testbot :Nickname is already in use.\r\n')
18
+        mock.send(':localhost 001 testbot1 :Welcome to the Internet Relay Chat Network testbot\r\n');
19
+    });
20
+
21
+    client.on('registered', function() {
22
+        t.equal(mock.outgoing[0], expected.received[0][0], expected.received[0][1]);
23
+        t.equal(mock.outgoing[1], expected.received[1][0], expected.received[1][1]);
24
+        client.disconnect(function() {
25
+            t.equal(client.hostMask, 'testbot', 'hostmask is as expected after 433');
26
+            t.equal(client.nick, 'testbot1', 'nick is as expected after 433');
27
+            t.equal(client.maxLineLength, 482, 'maxLineLength is as expected after 433');
28
+        });
29
+    });
30
+
31
+    mock.on('end', function() {
32
+        var msgs = mock.getIncomingMsgs();
33
+
34
+        for (var i = 0; i < msgs.length; i++) {
35
+            t.equal(msgs[i], expected.sent[i][0], expected.sent[i][1]);
36
+        }
37
+        mock.close();
38
+    });
39
+});
... ...
@@ -0,0 +1,36 @@
1
+var net = require('net');
2
+
3
+var irc = require('../lib/irc');
4
+var test = require('tape');
5
+
6
+var testHelpers = require('./helpers');
7
+
8
+test('user gets opped in auditorium', function(t) {
9
+    var mock = testHelpers.MockIrcd();
10
+    var client = new irc.Client('localhost', 'testbot', {debug: true});
11
+
12
+    client.on('+mode', function(channel, by, mode, argument) {
13
+        if (channel == '#auditorium' && argument == 'user') {
14
+            client.disconnect();
15
+        }
16
+    });
17
+
18
+    mock.server.on('connection', function() {
19
+        // Initiate connection
20
+        mock.send(':localhost 001 testbot :Welcome to the Internet Relay Chat Network testbot\r\n');
21
+
22
+        // Set prefix modes
23
+        mock.send(':localhost 005 testbot PREFIX=(ov)@+ CHANTYPES=#& :are supported by this server\r\n');
24
+
25
+        // Force join into auditorium
26
+        mock.send(':testbot JOIN #auditorium\r\n');
27
+
28
+        // +o the invisible user
29
+        mock.send(':ChanServ MODE #auditorium +o user\r\n');
30
+    });
31
+
32
+    mock.on('end', function() {
33
+        mock.close();
34
+        t.end();
35
+    });
36
+});
... ...
@@ -0,0 +1,53 @@
1
+var irc = require('../lib/irc');
2
+var test = require('tape');
3
+var testHelpers = require('./helpers');
4
+var checks = testHelpers.getFixtures('convert-encoding');
5
+var bindTo = { opt: { encoding: 'utf-8' } };
6
+
7
+test('irc.Client.convertEncoding old', function(assert) {
8
+    var convertEncoding = function(str) {
9
+        var self = this;
10
+
11
+        if (self.opt.encoding) {
12
+            var charsetDetector = require('node-icu-charset-detector');
13
+            var Iconv = require('iconv').Iconv;
14
+            var charset = charsetDetector.detectCharset(str).toString();
15
+            var to = new Iconv(charset, self.opt.encoding);
16
+
17
+            return to.convert(str);
18
+        } else {
19
+            return str;
20
+        }
21
+    }.bind(bindTo);
22
+
23
+    checks.causesException.forEach(function iterate(line) {
24
+        var causedException = false;
25
+        try {
26
+            convertEncoding(line);
27
+        } catch (e) {
28
+            causedException = true;
29
+        }
30
+
31
+        assert.equal(causedException, true, line + ' caused exception');
32
+    });
33
+
34
+    assert.end();
35
+});
36
+
37
+test('irc.Client.convertEncoding', function(assert) {
38
+    var convertEncoding = irc.Client.prototype.convertEncoding.bind(bindTo);
39
+
40
+    checks.causesException.forEach(function iterate(line) {
41
+        var causedException = false;
42
+
43
+        try {
44
+            convertEncoding(line);
45
+        } catch (e) {
46
+            causedException = true;
47
+        }
48
+
49
+        assert.equal(causedException, false, line + ' didn\'t cause exception');
50
+    });
51
+
52
+    assert.end();
53
+});
... ...
@@ -0,0 +1,33 @@
1
+var net = require('net');
2
+
3
+var irc = require('../lib/irc');
4
+var test = require('tape');
5
+
6
+var testHelpers = require('./helpers');
7
+
8
+test('sent messages ending with double CRLF', function(t) {
9
+    var mock = testHelpers.MockIrcd();
10
+    var client = new irc.Client('localhost', 'testbot', { debug: true});
11
+
12
+    var expected = testHelpers.getFixtures('double-CRLF');
13
+
14
+    t.plan(expected.sent.length + expected.received.length);
15
+
16
+    mock.server.on('connection', function() {
17
+        mock.send(expected.received[0][0]);
18
+    });
19
+
20
+    client.on('registered', function() {
21
+        t.equal(mock.outgoing[0], expected.received[0][0], expected.received[0][1]);
22
+        client.disconnect();
23
+    });
24
+
25
+    mock.on('end', function() {
26
+        var msgs = mock.getIncomingMsgs();
27
+
28
+        for (var i = 0; i < msgs.length; i++) {
29
+            t.equal(msgs[i], expected.sent[i][0], expected.sent[i][1]);
30
+        }
31
+        mock.close();
32
+    });
33
+});
... ...
@@ -0,0 +1,132 @@
1
+var net = require('net');
2
+
3
+var irc = require('../lib/irc');
4
+var test = require('tape');
5
+
6
+var testHelpers = require('./helpers');
7
+
8
+var expected = testHelpers.getFixtures('basic');
9
+var greeting = ':localhost 001 testbot :Welcome to the Internet Relay Chat Network testbot\r\n';
10
+
11
+test('connect, register and quit', function(t) {
12
+    runTests(t, false, false);
13
+});
14
+
15
+test('connect, register and quit, securely', function(t) {
16
+    runTests(t, true, false);
17
+});
18
+
19
+test('connect, register and quit, securely, with secure object', function(t) {
20
+    runTests(t, true, true);
21
+});
22
+
23
+function runTests(t, isSecure, useSecureObject) {
24
+    var port = isSecure ? 6697 : 6667;
25
+    var mock = testHelpers.MockIrcd(port, 'utf-8', isSecure);
26
+    var client;
27
+    if (isSecure && useSecureObject) {
28
+        client = new irc.Client('notlocalhost', 'testbot', {
29
+            secure: {
30
+                host: 'localhost',
31
+                port: port,
32
+                rejectUnauthorized: false
33
+            },
34
+            selfSigned: true,
35
+            retryCount: 0,
36
+            debug: true
37
+        });
38
+    } else {
39
+        var client = new irc.Client('localhost', 'testbot', {
40
+            secure: isSecure,
41
+            selfSigned: true,
42
+            port: port,
43
+            retryCount: 0,
44
+            debug: true
45
+        });
46
+    }
47
+
48
+    t.plan(expected.sent.length + expected.received.length);
49
+
50
+    mock.server.on(isSecure ? 'secureConnection' : 'connection', function() {
51
+        mock.send(greeting);
52
+    });
53
+
54
+    client.on('registered', function() {
55
+        t.equal(mock.outgoing[0], expected.received[0][0], expected.received[0][1]);
56
+        client.disconnect();
57
+    });
58
+
59
+    mock.on('end', function() {
60
+        var msgs = mock.getIncomingMsgs();
61
+
62
+        for (var i = 0; i < msgs.length; i++) {
63
+            t.equal(msgs[i], expected.sent[i][0], expected.sent[i][1]);
64
+        }
65
+        mock.close();
66
+    });
67
+}
68
+
69
+test ('splitting of long lines', function(t) {
70
+    var port = 6667;
71
+    var mock = testHelpers.MockIrcd(port, 'utf-8', false);
72
+    var client = new irc.Client('localhost', 'testbot', {
73
+        secure: false,
74
+        selfSigned: true,
75
+        port: port,
76
+        retryCount: 0,
77
+        debug: true
78
+    });
79
+
80
+    var group = testHelpers.getFixtures('_splitLongLines');
81
+    t.plan(group.length);
82
+    group.forEach(function(item) {
83
+        t.deepEqual(client._splitLongLines(item.input, item.maxLength, []), item.result);
84
+    });
85
+    mock.close();
86
+});
87
+
88
+test ('splitting of long lines with no maxLength defined.', function(t) {
89
+    var port = 6667;
90
+    var mock = testHelpers.MockIrcd(port, 'utf-8', false);
91
+    var client = new irc.Client('localhost', 'testbot', {
92
+        secure: false,
93
+        selfSigned: true,
94
+        port: port,
95
+        retryCount: 0,
96
+        debug: true
97
+    });
98
+
99
+    var group = testHelpers.getFixtures('_splitLongLines_no_max');
100
+    console.log(group.length);
101
+    t.plan(group.length);
102
+    group.forEach(function(item) {
103
+        t.deepEqual(client._splitLongLines(item.input, null, []), item.result);
104
+    });
105
+    mock.close();
106
+});
107
+
108
+test ('opt.messageSplit used when set', function(t) {
109
+    var port = 6667;
110
+    var mock = testHelpers.MockIrcd(port, 'utf-8', false);
111
+    var client = new irc.Client('localhost', 'testbot', {
112
+        secure: false,
113
+        selfSigned: true,
114
+        port: port,
115
+        retryCount: 0,
116
+        debug: true,
117
+        messageSplit: 10
118
+    });
119
+
120
+    var group = testHelpers.getFixtures('_speak');
121
+    t.plan(group.length);
122
+    group.forEach(function(item) {
123
+        client.maxLineLength = item.length;
124
+        client._splitLongLines = function(words, maxLength, destination) {
125
+            t.equal(maxLength, item.expected);
126
+            return [words];
127
+        }
128
+        client._speak('kind', 'target', 'test message');
129
+    });
130
+
131
+    mock.close();
132
+});
... ...
@@ -0,0 +1,68 @@
1
+var irc = require('../lib/irc');
2
+var test = require('tape');
3
+
4
+var testHelpers = require('./helpers');
5
+
6
+test('various origins and types of chanmodes get handled correctly', function(t) {
7
+    var mock = testHelpers.MockIrcd();
8
+    var client = new irc.Client('localhost', 'testbot', { debug: true });
9
+
10
+    var count = 0;
11
+    client.on('+mode', function() {
12
+        //console.log(client.chans['#channel']);
13
+        t.deepEqual(client.chans['#channel'], expected[count++]);
14
+    });
15
+    client.on('-mode', function() {
16
+        //console.log(client.chans['#channel']);
17
+        t.deepEqual(client.chans['#channel'], expected[count++]);
18
+    });
19
+
20
+    var expected = [
21
+        { key: '#channel', serverName: '#channel', users: {}, modeParams: { n: [] }, mode: 'n' },
22
+        { key: '#channel', serverName: '#channel', users: {}, modeParams: { n: [], t: [] }, mode: 'nt' },
23
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntb', modeParams: { b: ['*!*@AN.IP.1'], n: [], t: [] } },
24
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntb', modeParams: { b: ['*!*@AN.IP.1', '*!*@AN.IP.2'], n: [], t: [] } },
25
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntb', modeParams: { b: ['*!*@AN.IP.1', '*!*@AN.IP.2', '*!*@AN.IP.3'], n: [], t: [] } },
26
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntb', modeParams: { b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
27
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbf', modeParams: { f: ['[10j]:15'], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
28
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbf', modeParams: { f: ['[8j]:15'], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
29
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntb', modeParams: { b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
30
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbj', modeParams: { j: ['3:5'], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
31
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbj', modeParams: { j: ['2:5'], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
32
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntb', modeParams: { b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
33
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbp', modeParams: { p: [], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
34
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbps', modeParams: { s: [], p: [], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
35
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbpsK', modeParams: { K: [], s: [], p: [], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
36
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbsK', modeParams: { K: [], s: [], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
37
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbK', modeParams: { K: [], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } },
38
+        { key: '#channel', serverName: '#channel', users: { testbot: '@' }, mode: '+ntbKF', modeParams: { F: [], K: [], b: ['*!*@AN.IP.1', '*!*@AN.IP.3'], n: [], t: [] } }
39
+    ];
40
+
41
+    mock.server.on('connection', function() {
42
+        mock.send(':localhost 001 testbot :Welcome!\r\n');
43
+        mock.send(':localhost 005 testbot MODES=12 CHANTYPES=# PREFIX=(ohv)@%+ CHANMODES=beIqa,kfL,lj,psmntirRcOAQKVCuzNSMTGHFEB\r\n');
44
+        mock.send(':testbot MODE testbot :+ix\r\n');
45
+        mock.send(':testbot JOIN :#channel\r\n');
46
+        mock.send(':localhost MODE #channel +nt\r\n');
47
+        mock.send(':localhost 353 testbot = #channel :@testbot\r\n');
48
+        mock.send(':localhost 366 testbot #channel :End of /NAMES list.\r\n');
49
+        mock.send(':localhost 324 testbot #channel +nt\r\n');
50
+        mock.send(':localhost MODE #channel +b *!*@AN.IP.1\r\n');
51
+        mock.send(':localhost MODE #channel +bb *!*@AN.IP.2 *!*@AN.IP.3\r\n');
52
+        mock.send(':localhost MODE #channel -b *!*@AN.IP.2\r\n');
53
+        mock.send(':localhost MODE #channel +f [10j]:15\r\n');
54
+        mock.send(':localhost MODE #channel +f [8j]:15\r\n');
55
+        mock.send(':localhost MODE #channel -f+j [10j]:15 3:5\r\n');
56
+        mock.send(':localhost MODE #channel +j 2:5\r\n');
57
+        mock.send(':localhost MODE #channel -j\r\n');
58
+        mock.send(':localhost MODE #channel +ps\r\n');
59
+        mock.send(':localhost MODE #channel +K-p-s+F\r\n');
60
+
61
+        client.disconnect();
62
+    });
63
+
64
+    mock.on('end', function() {
65
+        mock.close();
66
+        t.end();
67
+    });
68
+});
... ...
@@ -0,0 +1,22 @@
1
+var parseMessage  = require('../lib/parse_message');
2
+var test = require('tape');
3
+
4
+var testHelpers = require('./helpers');
5
+
6
+test('irc.parseMessage', function(t) {
7
+    var checks = testHelpers.getFixtures('parse-line');
8
+
9
+    Object.keys(checks).forEach(function(line) {
10
+        var stripColors = false;
11
+        if (checks[line].hasOwnProperty('stripColors')) {
12
+            stripColors = checks[line].stripColors;
13
+            delete checks[line].stripColors;
14
+        }
15
+        t.equal(
16
+            JSON.stringify(checks[line]),
17
+            JSON.stringify(parseMessage(line, stripColors)),
18
+            line + ' parses correctly'
19
+        );
20
+    });
21
+    t.end();
22
+});
... ...
@@ -0,0 +1,541 @@
1
+# NAN ChangeLog
2
+
3
+**Version 2.15.0: current Node 16.6.1, Node 0.12: 0.12.18, Node 0.10: 0.10.48, iojs: 3.3.1**
4
+
5
+### 2.15.0 Aug 4 2021
6
+
7
+  - Feature: add ScriptOrigin (#918) d09debf9eeedcb7ca4073e84ffe5fbb455ecb709
8
+
9
+### 2.14.2 Oct 13 2020
10
+
11
+  - Bugfix: fix gcc 8 function cast warning (#899) 35f0fab205574b2cbda04e6347c8b2db755e124f
12
+
13
+### 2.14.1 Apr 21 2020
14
+
15
+  - Bugfix: use GetBackingStore() instead of GetContents() (#888) 2c023bd447661a61071da318b0ff4003c3858d39
16
+
17
+### 2.14.0 May 16 2019
18
+
19
+  - Feature: Add missing methods to Nan::Maybe<T> (#852) 4e962489fb84a184035b9fa74f245f650249aca6
20
+
21
+### 2.13.2 Mar 24 2019
22
+
23
+  - Bugfix: remove usage of deprecated `IsNearDeath` (#842) fbaf42252af279c3d867c6b193571f9711c39847
24
+
25
+### 2.13.1 Mar 14 2019
26
+
27
+  - Bugfix: check V8 version directly instead of inferring from NMV (#840) 12f9df9f393285de8fb4a8cd01478dc4fe3b089d
28
+
29
+### 2.13.0 Mar 13 2019
30
+
31
+  - Feature: add support for node master (#831) 113c0282072e7ff4f9dfc98b432fd894b798c2c
32
+
33
+### 2.12.1 Dec 18 2018
34
+
35
+  - Bugfix: Fix build breakage with Node.js 10.0.0-10.9.0. (#833) 625e90e8fef8d39ffa7247250a76a100b2487474
36
+
37
+### 2.12.0 Dec 16 2018
38
+
39
+  - Bugfix: Add scope.Escape() to Call() (#817) 2e5ed4fc3a8ac80a6ef1f2a55099ab3ac8800dc6
40
+  - Bugfix: Fix Node.js v10.12.0 deprecation warnings. 509859cc23b1770376b56550a027840a2ce0f73d
41
+  - Feature: Allow SetWeak() for non-object persistent handles. (#824) e6ef6a48e7e671fe3e4b7dddaa8912a3f8262ecd
42
+
43
+### 2.11.1 Sep 29 2018
44
+
45
+  - Fix: adapt to V8 7.0 24a22c3b25eeeec2016c6ec239bdd6169e985447
46
+
47
+### 2.11.0 Aug 25 2018
48
+
49
+  - Removal: remove `FunctionCallbackInfo::Callee` for nodejs `>= 10` 1a56c0a6efd4fac944cb46c30912a8e023bda7d4
50
+  - Bugfix: Fix `AsyncProgressWorkerBase::WorkProgress` sends invalid data b0c764d1dab11e9f8b37ffb81e2560a4498aad5e
51
+  - Feature: Introduce `GetCurrentEventLoop` b4911b0bb1f6d47d860e10ec014d941c51efac5e
52
+  - Feature: Add `NAN_MODULE_WORKER_ENABLED` macro as a replacement for `NAN_MODULE` b058fb047d18a58250e66ae831444441c1f2ac7a
53
+
54
+### 2.10.0 Mar 16 2018
55
+
56
+  - Deprecation: Deprecate `MakeCallback` 5e92b19a59e194241d6a658bd6ff7bfbda372950
57
+  - Feature: add `Nan::Call` overload 4482e1242fe124d166fc1a5b2be3c1cc849fe452
58
+  - Feature: add more `Nan::Call` overloads 8584e63e6d04c7d2eb8c4a664e4ef57d70bf672b
59
+  - Feature: Fix deprecation warnings for Node 10 1caf258243b0602ed56922bde74f1c91b0cbcb6a
60
+
61
+### 2.9.2 Feb 22 2018
62
+
63
+  - Bugfix: Bandaid for async hooks 212bd2f849be14ef1b02fc85010b053daa24252b
64
+
65
+### 2.9.1 Feb 22 2018
66
+
67
+  - Bugfix: Avoid deprecation warnings in deprecated `Nan::Callback::operator()` 372b14d91289df4604b0f81780709708c45a9aa4
68
+  - Bugfix: Avoid deprecation warnings in `Nan::JSON` 3bc294bce0b7d0a3ee4559926303e5ed4866fda2
69
+
70
+### 2.9.0 Feb 22 2018
71
+
72
+  - Deprecation: Deprecate legacy `Callback::Call` 6dd5fa690af61ca3523004b433304c581b3ea309
73
+  - Feature: introduce `AsyncResource` class 90c0a179c0d8cb5fd26f1a7d2b1d6231eb402d48o
74
+  - Feature: Add context aware `Nan::Callback::Call` functions 7169e09fb088418b6e388222e88b4c13f07ebaee
75
+  - Feature: Make `AsyncWorker` context aware 066ba21a6fb9e2b5230c9ed3a6fc51f1211736a4
76
+  - Feature: add `Callback` overload to `Nan::Call` 5328daf66e202658c1dc0d916c3aaba99b3cc606
77
+  - Bugfix: fix warning: suggest parentheses around `&&` within `||` b2bb63d68b8ae623a526b542764e1ac82319cb2c
78
+  - Bugfix: Fix compilation on io.js 3 d06114dba0a522fb436f0c5f47b994210968cd7b
79
+
80
+### 2.8.0 Nov 15 2017
81
+
82
+  - Deprecation: Deprecate `Nan::ForceSet` in favor of `Nan::DefineOwnProperty()` 95cbb976d6fbbba88ba0f86dd188223a8591b4e7
83
+  - Feature: Add `Nan::AsyncProgressQueueWorker` a976636ecc2ef617d1b061ce4a6edf39923691cb
84
+  - Feature: Add `Nan::DefineOwnProperty()` 95cbb976d6fbbba88ba0f86dd188223a8591b4e7
85
+  - Bugfix: Fix compiling on io.js 1 & 2 82705a64503ce60c62e98df5bd02972bba090900
86
+  - Bugfix: Use DefineOwnProperty instead of ForceSet 95cbb976d6fbbba88ba0f86dd188223a8591b4e7
87
+
88
+### 2.7.0 Aug 30 2017
89
+
90
+  - Feature: Add `Nan::To<v8::Function>()` overload. b93280670c9f6da42ed4cf6cbf085ffdd87bd65b
91
+  - Bugfix: Fix ternary in `Nan::MaybeLocal<T>::FromMaybe<S>()`. 79a26f7d362e756a9524e672a82c3d603b542867
92
+
93
+### 2.6.2 Apr 12 2017
94
+
95
+  - Bugfix: Fix v8::JSON::Parse() deprecation warning. 87f6a3c65815fa062296a994cc863e2fa124867d
96
+
97
+### 2.6.1 Apr 6 2017
98
+
99
+  - Bugfix: nan_json.h: fix build breakage in Node 6 ac8d47dc3c10bfbf3f15a6b951633120c0ee6d51
100
+
101
+### 2.6.0 Apr 6 2017
102
+
103
+  - Feature: nan: add support for JSON::Parse & Stringify b533226c629cce70e1932a873bb6f849044a56c5
104
+
105
+### 2.5.1 Jan 23 2017
106
+
107
+  - Bugfix: Fix disappearing handle for private value 6a80995694f162ef63dbc9948fbefd45d4485aa0
108
+  - Bugfix: Add missing scopes a93b8bae6bc7d32a170db6e89228b7f60ee57112
109
+  - Bugfix: Use string::data instead of string::front in NewOneByteString d5f920371e67e1f3b268295daee6e83af86b6e50
110
+
111
+### 2.5.0 Dec 21 2016
112
+
113
+  - Feature: Support Private accessors a86255cb357e8ad8ccbf1f6a4a901c921e39a178
114
+  - Bugfix: Abort in delete operators that shouldn't be called 0fe38215ff8581703967dfd26c12793feb960018
115
+
116
+### 2.4.0 Jul 10 2016
117
+
118
+  - Feature: Rewrite Callback to add Callback::Reset c4cf44d61f8275cd5f7b0c911d7a806d4004f649
119
+  - Feature: AsyncProgressWorker: add template types for .send 1242c9a11a7ed481c8f08ec06316385cacc513d0
120
+  - Bugfix: Add constness to old Persistent comparison operators bd43cb9982c7639605d60fd073efe8cae165d9b2
121
+
122
+### 2.3.5 May 31 2016
123
+
124
+  - Bugfix: Replace NAN_INLINE with 'inline' keyword. 71819d8725f822990f439479c9aba3b240804909
125
+
126
+### 2.3.4 May 31 2016
127
+
128
+  - Bugfix: Remove V8 deprecation warnings 0592fb0a47f3a1c7763087ebea8e1138829f24f9
129
+  - Bugfix: Fix new versions not to use WeakCallbackInfo::IsFirstPass 615c19d9e03d4be2049c10db0151edbc3b229246
130
+  - Bugfix: Make ObjectWrap::handle() const d19af99595587fe7a26bd850af6595c2a7145afc
131
+  - Bugfix: Fix compilation errors related to 0592fb0a47f3a1c7763087ebea8e1138829f24f9 e9191c525b94f652718325e28610a1adcf90fed8
132
+
133
+### 2.3.3 May 4 2016
134
+
135
+  - Bugfix: Refactor SetMethod() to deal with v8::Templates (#566) b9083cf6d5de6ebe6bcb49c7502fbb7c0d9ddda8
136
+
137
+### 2.3.2 Apr 27 2016
138
+
139
+  - Bugfix: Fix compilation on outdated versions due to Handle removal f8b7c875d04d425a41dfd4f3f8345bc3a11e6c52
140
+
141
+### 2.3.1 Apr 27 2016
142
+
143
+  - Bugfix: Don't use deprecated v8::Template::Set() in SetMethod a90951e9ea70fa1b3836af4b925322919159100e
144
+
145
+### 2.3.0 Apr 27 2016
146
+
147
+  - Feature: added Signal() for invoking async callbacks without sending data from AsyncProgressWorker d8adba45f20e077d00561b20199133620c990b38
148
+  - Bugfix: Don't use deprecated v8::Template::Set() 00dacf0a4b86027415867fa7f1059acc499dcece
149
+
150
+### 2.2.1 Mar 29 2016
151
+
152
+  - Bugfix: Use NewFromUnsigned in ReturnValue<T>::Set(uint32_t i) for pre_12 3a18f9bdce29826e0e4c217854bc476918241a58
153
+  - Performance: Remove unneeeded nullptr checks b715ef44887931c94f0d1605b3b1a4156eebece9
154
+
155
+### 2.2.0 Jan 9 2016
156
+
157
+  - Feature: Add Function::Call wrapper 4c157474dacf284d125c324177b45aa5dabc08c6
158
+  - Feature: Rename GC*logueCallback to GCCallback for > 4.0 3603435109f981606d300eb88004ca101283acec
159
+  - Bugfix: Fix Global::Pass for old versions 367e82a60fbaa52716232cc89db1cc3f685d77d9
160
+  - Bugfix: Remove weird MaybeLocal wrapping of what already is a MaybeLocal 23b4590db10c2ba66aee2338aebe9751c4cb190b
161
+
162
+### 2.1.0 Oct 8 2015
163
+
164
+  - Deprecation: Deprecate NanErrnoException in favor of ErrnoException 0af1ca4cf8b3f0f65ed31bc63a663ab3319da55c
165
+  - Feature: added helper class for accessing contents of typedarrays 17b51294c801e534479d5463697a73462d0ca555
166
+  - Feature: [Maybe types] Add MakeMaybe(...) 48d7b53d9702b0c7a060e69ea10fea8fb48d814d
167
+  - Feature: new: allow utf16 string with length 66ac6e65c8ab9394ef588adfc59131b3b9d8347b
168
+  - Feature: Introduce SetCallHandler and SetCallAsFunctionHandler 7764a9a115d60ba10dc24d86feb0fbc9b4f75537
169
+  - Bugfix: Enable creating Locals from Globals under Node 0.10. 9bf9b8b190821af889790fdc18ace57257e4f9ff
170
+  - Bugfix: Fix issue #462 where PropertyCallbackInfo data is not stored safely. 55f50adedd543098526c7b9f4fffd607d3f9861f
171
+
172
+### 2.0.9 Sep 8 2015
173
+
174
+  - Bugfix: EscapableHandleScope in Nan::NewBuffer for Node 0.8 and 0.10 b1654d7
175
+
176
+### 2.0.8 Aug 28 2015
177
+
178
+  - Work around duplicate linking bug in clang 11902da
179
+
180
+### 2.0.7 Aug 26 2015
181
+
182
+  - Build: Repackage
183
+
184
+### 2.0.6 Aug 26 2015
185
+
186
+  - Bugfix: Properly handle null callback in FunctionTemplate factory 6e99cb1
187
+  - Bugfix: Remove unused static std::map instances 525bddc
188
+  - Bugfix: Make better use of maybe versions of APIs bfba85b
189
+  - Bugfix: Fix shadowing issues with handle in ObjectWrap 0a9072d
190
+
191
+### 2.0.5 Aug 10 2015
192
+
193
+  - Bugfix: Reimplement weak callback in ObjectWrap 98d38c1
194
+  - Bugfix: Make sure callback classes are not assignable, copyable or movable 81f9b1d
195
+
196
+### 2.0.4 Aug 6 2015
197
+
198
+  - Build: Repackage
199
+
200
+### 2.0.3 Aug 6 2015
201
+
202
+  - Bugfix: Don't use clang++ / g++ syntax extension. 231450e
203
+
204
+### 2.0.2 Aug 6 2015
205
+
206
+  - Build: Repackage
207
+
208
+### 2.0.1 Aug 6 2015
209
+
210
+  - Bugfix: Add workaround for missing REPLACE_INVALID_UTF8 60d6687
211
+  - Bugfix: Reimplement ObjectWrap from scratch to prevent memory leaks 6484601
212
+  - Bugfix: Fix Persistent leak in FunctionCallbackInfo and PropertyCallbackInfo 641ef5f
213
+  - Bugfix: Add missing overload for Nan::NewInstance that takes argc/argv 29450ed
214
+
215
+### 2.0.0 Jul 31 2015
216
+
217
+  - Change: Renamed identifiers with leading underscores	b5932b4
218
+  - Change: Replaced NanObjectWrapHandle with class NanObjectWrap	464f1e1
219
+  - Change: Replace NanScope and NanEscpableScope macros with classes	47751c4
220
+  - Change: Rename NanNewBufferHandle to NanNewBuffer	6745f99
221
+  - Change: Rename NanBufferUse to NanNewBuffer	3e8b0a5
222
+  - Change: Rename NanNewBuffer to NanCopyBuffer	d6af78d
223
+  - Change: Remove Nan prefix from all names	72d1f67
224
+  - Change: Update Buffer API for new upstream changes	d5d3291
225
+  - Change: Rename Scope and EscapableScope to HandleScope and EscapableHandleScope	21a7a6a
226
+  - Change: Get rid of Handles	 e6c0daf
227
+  - Feature: Support io.js 3 with V8 4.4
228
+  - Feature: Introduce NanPersistent	7fed696
229
+  - Feature: Introduce NanGlobal	4408da1
230
+  - Feature: Added NanTryCatch	10f1ca4
231
+  - Feature: Update for V8 v4.3	4b6404a
232
+  - Feature: Introduce NanNewOneByteString	c543d32
233
+  - Feature: Introduce namespace Nan	67ed1b1
234
+  - Removal: Remove NanLocker and NanUnlocker	dd6e401
235
+  - Removal: Remove string converters, except NanUtf8String, which now follows the node implementation b5d00a9
236
+  - Removal: Remove NanReturn* macros	d90a25c
237
+  - Removal: Remove HasInstance	e8f84fe
238
+
239
+
240
+### 1.9.0 Jul 31 2015
241
+
242
+  - Feature: Added `NanFatalException` 81d4a2c
243
+  - Feature: Added more error types 4265f06
244
+  - Feature: Added dereference and function call operators to NanCallback c4b2ed0
245
+  - Feature: Added indexed GetFromPersistent and SaveToPersistent edd510c
246
+  - Feature: Added more overloads of SaveToPersistent and GetFromPersistent 8b1cef6
247
+  - Feature: Added NanErrnoException dd87d9e
248
+  - Correctness: Prevent assign, copy, and move for classes that do not support it 1f55c59, 4b808cb, c96d9b2, fba4a29, 3357130
249
+  - Deprecation: Deprecate `NanGetPointerSafe` and `NanSetPointerSafe` 81d4a2c
250
+  - Deprecation: Deprecate `NanBooleanOptionValue` and `NanUInt32OptionValue` 0ad254b
251
+
252
+### 1.8.4 Apr 26 2015
253
+
254
+  - Build: Repackage
255
+
256
+### 1.8.3 Apr 26 2015
257
+
258
+  - Bugfix: Include missing header 1af8648
259
+
260
+### 1.8.2 Apr 23 2015
261
+
262
+  - Build: Repackage
263
+
264
+### 1.8.1 Apr 23 2015
265
+
266
+  - Bugfix: NanObjectWrapHandle should take a pointer 155f1d3
267
+
268
+### 1.8.0 Apr 23 2015
269
+
270
+  - Feature: Allow primitives with NanReturnValue 2e4475e
271
+  - Feature: Added comparison operators to NanCallback 55b075e
272
+  - Feature: Backport thread local storage 15bb7fa
273
+  - Removal: Remove support for signatures with arguments 8a2069d
274
+  - Correcteness: Replaced NanObjectWrapHandle macro with function 0bc6d59
275
+
276
+### 1.7.0 Feb 28 2015
277
+
278
+  - Feature: Made NanCallback::Call accept optional target 8d54da7
279
+  - Feature: Support atom-shell 0.21 0b7f1bb
280
+
281
+### 1.6.2 Feb 6 2015
282
+
283
+  - Bugfix: NanEncode: fix argument type for node::Encode on io.js 2be8639
284
+
285
+### 1.6.1 Jan 23 2015
286
+
287
+  - Build: version bump
288
+
289
+### 1.5.3 Jan 23 2015
290
+
291
+  - Build: repackage
292
+
293
+### 1.6.0 Jan 23 2015
294
+
295
+ - Deprecated `NanNewContextHandle` in favor of `NanNew<Context>` 49259af
296
+ - Support utility functions moved in newer v8 versions (Node 0.11.15, io.js 1.0) a0aa179
297
+ - Added `NanEncode`, `NanDecodeBytes` and `NanDecodeWrite` 75e6fb9
298
+
299
+### 1.5.2 Jan 23 2015
300
+
301
+  - Bugfix: Fix non-inline definition build error with clang++ 21d96a1, 60fadd4
302
+  - Bugfix: Readded missing String constructors 18d828f
303
+  - Bugfix: Add overload handling NanNew<FunctionTemplate>(..) 5ef813b
304
+  - Bugfix: Fix uv_work_cb versioning 997e4ae
305
+  - Bugfix: Add function factory and test 4eca89c
306
+  - Bugfix: Add object template factory and test cdcb951
307
+  - Correctness: Lifted an io.js related typedef c9490be
308
+  - Correctness: Make explicit downcasts of String lengths 00074e6
309
+  - Windows: Limit the scope of disabled warning C4530 83d7deb
310
+
311
+### 1.5.1 Jan 15 2015
312
+
313
+  - Build: version bump
314
+
315
+### 1.4.3 Jan 15 2015
316
+
317
+  - Build: version bump
318
+
319
+### 1.4.2 Jan 15 2015
320
+
321
+  - Feature: Support io.js 0dbc5e8
322
+
323
+### 1.5.0 Jan 14 2015
324
+
325
+ - Feature: Support io.js b003843
326
+ - Correctness: Improved NanNew internals 9cd4f6a
327
+ - Feature: Implement progress to NanAsyncWorker 8d6a160
328
+
329
+### 1.4.1 Nov 8 2014
330
+
331
+ - Bugfix: Handle DEBUG definition correctly
332
+ - Bugfix: Accept int as Boolean
333
+
334
+### 1.4.0 Nov 1 2014
335
+
336
+ - Feature: Added NAN_GC_CALLBACK 6a5c245
337
+ - Performance: Removed unnecessary local handle creation 18a7243, 41fe2f8
338
+ - Correctness: Added constness to references in NanHasInstance 02c61cd
339
+ - Warnings: Fixed spurious warnings from -Wundef and -Wshadow, 541b122, 99d8cb6
340
+ - Windoze: Shut Visual Studio up when compiling 8d558c1
341
+ - License: Switch to plain MIT from custom hacked MIT license 11de983
342
+ - Build: Added test target to Makefile e232e46
343
+ - Performance: Removed superfluous scope in NanAsyncWorker f4b7821
344
+ - Sugar/Feature: Added NanReturnThis() and NanReturnHolder() shorthands 237a5ff, d697208
345
+ - Feature: Added suitable overload of NanNew for v8::Integer::NewFromUnsigned b27b450
346
+
347
+### 1.3.0 Aug 2 2014
348
+
349
+ - Added NanNew<v8::String, std::string>(std::string)
350
+ - Added NanNew<v8::String, std::string&>(std::string&)
351
+ - Added NanAsciiString helper class
352
+ - Added NanUtf8String helper class
353
+ - Added NanUcs2String helper class
354
+ - Deprecated NanRawString()
355
+ - Deprecated NanCString()
356
+ - Added NanGetIsolateData(v8::Isolate *isolate)
357
+ - Added NanMakeCallback(v8::Handle<v8::Object> target, v8::Handle<v8::Function> func, int argc, v8::Handle<v8::Value>* argv)
358
+ - Added NanMakeCallback(v8::Handle<v8::Object> target, v8::Handle<v8::String> symbol, int argc, v8::Handle<v8::Value>* argv)
359
+ - Added NanMakeCallback(v8::Handle<v8::Object> target, const char* method, int argc, v8::Handle<v8::Value>* argv)
360
+ - Added NanSetTemplate(v8::Handle<v8::Template> templ, v8::Handle<v8::String> name , v8::Handle<v8::Data> value, v8::PropertyAttribute attributes)
361
+ - Added NanSetPrototypeTemplate(v8::Local<v8::FunctionTemplate> templ, v8::Handle<v8::String> name, v8::Handle<v8::Data> value, v8::PropertyAttribute attributes)
362
+ - Added NanSetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ, const char *name, v8::Handle<v8::Data> value)
363
+ - Added NanSetInstanceTemplate(v8::Local<v8::FunctionTemplate> templ, v8::Handle<v8::String> name, v8::Handle<v8::Data> value, v8::PropertyAttribute attributes)
364
+
365
+### 1.2.0 Jun 5 2014
366
+
367
+ - Add NanSetPrototypeTemplate
368
+ - Changed NAN_WEAK_CALLBACK internals, switched _NanWeakCallbackData to class,
369
+     introduced _NanWeakCallbackDispatcher
370
+ - Removed -Wno-unused-local-typedefs from test builds
371
+ - Made test builds Windows compatible ('Sleep()')
372
+
373
+### 1.1.2 May 28 2014
374
+
375
+ - Release to fix more stuff-ups in 1.1.1
376
+
377
+### 1.1.1 May 28 2014
378
+
379
+ - Release to fix version mismatch in nan.h and lack of changelog entry for 1.1.0
380
+
381
+### 1.1.0 May 25 2014
382
+
383
+ - Remove nan_isolate, use v8::Isolate::GetCurrent() internally instead
384
+ - Additional explicit overloads for NanNew(): (char*,int), (uint8_t*[,int]),
385
+     (uint16_t*[,int), double, int, unsigned int, bool, v8::String::ExternalStringResource*,
386
+     v8::String::ExternalAsciiStringResource*
387
+ - Deprecate NanSymbol()
388
+ - Added SetErrorMessage() and ErrorMessage() to NanAsyncWorker
389
+
390
+### 1.0.0 May 4 2014
391
+
392
+ - Heavy API changes for V8 3.25 / Node 0.11.13
393
+ - Use cpplint.py
394
+ - Removed NanInitPersistent
395
+ - Removed NanPersistentToLocal
396
+ - Removed NanFromV8String
397
+ - Removed NanMakeWeak
398
+ - Removed NanNewLocal
399
+ - Removed NAN_WEAK_CALLBACK_OBJECT
400
+ - Removed NAN_WEAK_CALLBACK_DATA
401
+ - Introduce NanNew, replaces NanNewLocal, NanPersistentToLocal, adds many overloaded typed versions
402
+ - Introduce NanUndefined, NanNull, NanTrue and NanFalse
403
+ - Introduce NanEscapableScope and NanEscapeScope
404
+ - Introduce NanMakeWeakPersistent (requires a special callback to work on both old and new node)
405
+ - Introduce NanMakeCallback for node::MakeCallback
406
+ - Introduce NanSetTemplate
407
+ - Introduce NanGetCurrentContext
408
+ - Introduce NanCompileScript and NanRunScript
409
+ - Introduce NanAdjustExternalMemory
410
+ - Introduce NanAddGCEpilogueCallback, NanAddGCPrologueCallback, NanRemoveGCEpilogueCallback, NanRemoveGCPrologueCallback
411
+ - Introduce NanGetHeapStatistics
412
+ - Rename NanAsyncWorker#SavePersistent() to SaveToPersistent()
413
+
414
+### 0.8.0 Jan 9 2014
415
+
416
+ - NanDispose -> NanDisposePersistent, deprecate NanDispose
417
+ - Extract _NAN_*_RETURN_TYPE, pull up NAN_*()
418
+
419
+### 0.7.1 Jan 9 2014
420
+
421
+ - Fixes to work against debug builds of Node
422
+ - Safer NanPersistentToLocal (avoid reinterpret_cast)
423
+ - Speed up common NanRawString case by only extracting flattened string when necessary
424
+
425
+### 0.7.0 Dec 17 2013
426
+
427
+ - New no-arg form of NanCallback() constructor.
428
+ - NanCallback#Call takes Handle rather than Local
429
+ - Removed deprecated NanCallback#Run method, use NanCallback#Call instead
430
+ - Split off _NAN_*_ARGS_TYPE from _NAN_*_ARGS
431
+ - Restore (unofficial) Node 0.6 compatibility at NanCallback#Call()
432
+ - Introduce NanRawString() for char* (or appropriate void*) from v8::String
433
+     (replacement for NanFromV8String)
434
+ - Introduce NanCString() for null-terminated char* from v8::String
435
+
436
+### 0.6.0 Nov 21 2013
437
+
438
+ - Introduce NanNewLocal<T>(v8::Handle<T> value) for use in place of
439
+     v8::Local<T>::New(...) since v8 started requiring isolate in Node 0.11.9
440
+
441
+### 0.5.2 Nov 16 2013
442
+
443
+ - Convert SavePersistent and GetFromPersistent in NanAsyncWorker from protected and public
444
+
445
+### 0.5.1 Nov 12 2013
446
+
447
+ - Use node::MakeCallback() instead of direct v8::Function::Call()
448
+
449
+### 0.5.0 Nov 11 2013
450
+
451
+ - Added @TooTallNate as collaborator
452
+ - New, much simpler, "include_dirs" for binding.gyp
453
+ - Added full range of NAN_INDEX_* macros to match NAN_PROPERTY_* macros
454
+
455
+### 0.4.4 Nov 2 2013
456
+
457
+ - Isolate argument from v8::Persistent::MakeWeak removed for 0.11.8+
458
+
459
+### 0.4.3 Nov 2 2013
460
+
461
+ - Include node_object_wrap.h, removed from node.h for Node 0.11.8.
462
+
463
+### 0.4.2 Nov 2 2013
464
+
465
+ - Handle deprecation of v8::Persistent::Dispose(v8::Isolate* isolate)) for
466
+     Node 0.11.8 release.
467
+
468
+### 0.4.1 Sep 16 2013
469
+
470
+ - Added explicit `#include <uv.h>` as it was removed from node.h for v0.11.8
471
+
472
+### 0.4.0 Sep 2 2013
473
+
474
+ - Added NAN_INLINE and NAN_DEPRECATED and made use of them
475
+ - Added NanError, NanTypeError and NanRangeError
476
+ - Cleaned up code
477
+
478
+### 0.3.2 Aug 30 2013
479
+
480
+ - Fix missing scope declaration in GetFromPersistent() and SaveToPersistent
481
+     in NanAsyncWorker
482
+
483
+### 0.3.1 Aug 20 2013
484
+
485
+ - fix "not all control paths return a value" compile warning on some platforms
486
+
487
+### 0.3.0 Aug 19 2013
488
+
489
+ - Made NAN work with NPM
490
+ - Lots of fixes to NanFromV8String, pulling in features from new Node core
491
+ - Changed node::encoding to Nan::Encoding in NanFromV8String to unify the API
492
+ - Added optional error number argument for NanThrowError()
493
+ - Added NanInitPersistent()
494
+ - Added NanReturnNull() and NanReturnEmptyString()
495
+ - Added NanLocker and NanUnlocker
496
+ - Added missing scopes
497
+ - Made sure to clear disposed Persistent handles
498
+ - Changed NanAsyncWorker to allocate error messages on the heap
499
+ - Changed NanThrowError(Local<Value>) to NanThrowError(Handle<Value>)
500
+ - Fixed leak in NanAsyncWorker when errmsg is used
501
+
502
+### 0.2.2 Aug 5 2013
503
+
504
+ - Fixed usage of undefined variable with node::BASE64 in NanFromV8String()
505
+
506
+### 0.2.1 Aug 5 2013
507
+
508
+ - Fixed 0.8 breakage, node::BUFFER encoding type not available in 0.8 for
509
+     NanFromV8String()
510
+
511
+### 0.2.0 Aug 5 2013
512
+
513
+ - Added NAN_PROPERTY_GETTER, NAN_PROPERTY_SETTER, NAN_PROPERTY_ENUMERATOR,
514
+     NAN_PROPERTY_DELETER, NAN_PROPERTY_QUERY
515
+ - Extracted _NAN_METHOD_ARGS, _NAN_GETTER_ARGS, _NAN_SETTER_ARGS,
516
+     _NAN_PROPERTY_GETTER_ARGS, _NAN_PROPERTY_SETTER_ARGS,
517
+     _NAN_PROPERTY_ENUMERATOR_ARGS, _NAN_PROPERTY_DELETER_ARGS,
518
+     _NAN_PROPERTY_QUERY_ARGS
519
+ - Added NanGetInternalFieldPointer, NanSetInternalFieldPointer
520
+ - Added NAN_WEAK_CALLBACK, NAN_WEAK_CALLBACK_OBJECT,
521
+     NAN_WEAK_CALLBACK_DATA, NanMakeWeak
522
+ - Renamed THROW_ERROR to _NAN_THROW_ERROR
523
+ - Added NanNewBufferHandle(char*, size_t, node::smalloc::FreeCallback, void*)
524
+ - Added NanBufferUse(char*, uint32_t)
525
+ - Added NanNewContextHandle(v8::ExtensionConfiguration*,
526
+       v8::Handle<v8::ObjectTemplate>, v8::Handle<v8::Value>)
527
+ - Fixed broken NanCallback#GetFunction()
528
+ - Added optional encoding and size arguments to NanFromV8String()
529
+ - Added NanGetPointerSafe() and NanSetPointerSafe()
530
+ - Added initial test suite (to be expanded)
531
+ - Allow NanUInt32OptionValue to convert any Number object
532
+
533
+### 0.1.0 Jul 21 2013
534
+
535
+ - Added `NAN_GETTER`, `NAN_SETTER`
536
+ - Added `NanThrowError` with single Local<Value> argument
537
+ - Added `NanNewBufferHandle` with single uint32_t argument
538
+ - Added `NanHasInstance(Persistent<FunctionTemplate>&, Handle<Value>)`
539
+ - Added `Local<Function> NanCallback#GetFunction()`
540
+ - Added `NanCallback#Call(int, Local<Value>[])`
541
+ - Deprecated `NanCallback#Run(int, Local<Value>[])` in favour of Call
... ...
@@ -0,0 +1,13 @@
1
+The MIT License (MIT)
2
+=====================
3
+
4
+Copyright (c) 2018 NAN contributors
5
+-----------------------------------
6
+
7
+*NAN contributors listed at <https://github.com/nodejs/nan#contributors>*
8
+
9
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
10
+
11
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12
+
13
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
... ...
@@ -0,0 +1,456 @@
1
+Native Abstractions for Node.js
2
+===============================
3
+
4
+**A header file filled with macro and utility goodness for making add-on development for Node.js easier across versions 0.8, 0.10, 0.12, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 and 16.**
5
+
6
+***Current version: 2.15.0***
7
+
8
+*(See [CHANGELOG.md](https://github.com/nodejs/nan/blob/master/CHANGELOG.md) for complete ChangeLog)*
9
+
10
+[![NPM](https://nodei.co/npm/nan.png?downloads=true&downloadRank=true)](https://nodei.co/npm/nan/) [![NPM](https://nodei.co/npm-dl/nan.png?months=6&height=3)](https://nodei.co/npm/nan/)
11
+
12
+[![Build Status](https://api.travis-ci.com/nodejs/nan.svg?branch=master)](https://travis-ci.com/nodejs/nan)
13
+[![Build status](https://ci.appveyor.com/api/projects/status/kh73pbm9dsju7fgh)](https://ci.appveyor.com/project/RodVagg/nan)
14
+
15
+Thanks to the crazy changes in V8 (and some in Node core), keeping native addons compiling happily across versions, particularly 0.10 to 0.12 to 4.0, is a minor nightmare. The goal of this project is to store all logic necessary to develop native Node.js addons without having to inspect `NODE_MODULE_VERSION` and get yourself into a macro-tangle.
16
+
17
+This project also contains some helper utilities that make addon development a bit more pleasant.
18
+
19
+ * **[News & Updates](#news)**
20
+ * **[Usage](#usage)**
21
+ * **[Example](#example)**
22
+ * **[API](#api)**
23
+ * **[Tests](#tests)**
24
+ * **[Known issues](#issues)**
25
+ * **[Governance & Contributing](#governance)**
26
+
27
+<a name="news"></a>
28
+
29
+## News & Updates
30
+
31
+<a name="usage"></a>
32
+
33
+## Usage
34
+
35
+Simply add **NAN** as a dependency in the *package.json* of your Node addon:
36
+
37
+``` bash
38
+$ npm install --save nan
39
+```
40
+
41
+Pull in the path to **NAN** in your *binding.gyp* so that you can use `#include <nan.h>` in your *.cpp* files:
42
+
43
+``` python
44
+"include_dirs" : [
45
+    "<!(node -e \"require('nan')\")"
46
+]
47
+```
48
+
49
+This works like a `-I<path-to-NAN>` when compiling your addon.
50
+
51
+<a name="example"></a>
52
+
53
+## Example
54
+
55
+Just getting started with Nan? Take a look at the **[Node Add-on Examples](https://github.com/nodejs/node-addon-examples)**.
56
+
57
+Refer to a [quick-start **Nan** Boilerplate](https://github.com/fcanas/node-native-boilerplate) for a ready-to-go project that utilizes basic Nan functionality.
58
+
59
+For a simpler example, see the **[async pi estimation example](https://github.com/nodejs/nan/tree/master/examples/async_pi_estimate)** in the examples directory for full code and an explanation of what this Monte Carlo Pi estimation example does. Below are just some parts of the full example that illustrate the use of **NAN**.
60
+
61
+Yet another example is **[nan-example-eol](https://github.com/CodeCharmLtd/nan-example-eol)**. It shows newline detection implemented as a native addon.
62
+
63
+Also take a look at our comprehensive **[C++ test suite](https://github.com/nodejs/nan/tree/master/test/cpp)** which has a plethora of code snippets for your pasting pleasure.
64
+
65
+<a name="api"></a>
66
+
67
+## API
68
+
69
+Additional to the NAN documentation below, please consult:
70
+
71
+* [The V8 Getting Started * Guide](https://v8.dev/docs/embed)
72
+* [V8 API Documentation](https://v8docs.nodesource.com/)
73
+* [Node Add-on Documentation](https://nodejs.org/api/addons.html)
74
+
75
+<!-- START API -->
76
+
77
+### JavaScript-accessible methods
78
+
79
+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.
80
+
81
+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.
82
+
83
+* **Method argument types**
84
+ - <a href="doc/methods.md#api_nan_function_callback_info"><b><code>Nan::FunctionCallbackInfo</code></b></a>
85
+ - <a href="doc/methods.md#api_nan_property_callback_info"><b><code>Nan::PropertyCallbackInfo</code></b></a>
86
+ - <a href="doc/methods.md#api_nan_return_value"><b><code>Nan::ReturnValue</code></b></a>
87
+* **Method declarations**
88
+ - <a href="doc/methods.md#api_nan_method"><b>Method declaration</b></a>
89
+ - <a href="doc/methods.md#api_nan_getter"><b>Getter declaration</b></a>
90
+ - <a href="doc/methods.md#api_nan_setter"><b>Setter declaration</b></a>
91
+ - <a href="doc/methods.md#api_nan_property_getter"><b>Property getter declaration</b></a>
92
+ - <a href="doc/methods.md#api_nan_property_setter"><b>Property setter declaration</b></a>
93
+ - <a href="doc/methods.md#api_nan_property_enumerator"><b>Property enumerator declaration</b></a>
94
+ - <a href="doc/methods.md#api_nan_property_deleter"><b>Property deleter declaration</b></a>
95
+ - <a href="doc/methods.md#api_nan_property_query"><b>Property query declaration</b></a>
96
+ - <a href="doc/methods.md#api_nan_index_getter"><b>Index getter declaration</b></a>
97
+ - <a href="doc/methods.md#api_nan_index_setter"><b>Index setter declaration</b></a>
98
+ - <a href="doc/methods.md#api_nan_index_enumerator"><b>Index enumerator declaration</b></a>
99
+ - <a href="doc/methods.md#api_nan_index_deleter"><b>Index deleter declaration</b></a>
100
+ - <a href="doc/methods.md#api_nan_index_query"><b>Index query declaration</b></a>
101
+* Method and template helpers
102
+ - <a href="doc/methods.md#api_nan_set_method"><b><code>Nan::SetMethod()</code></b></a>
103
+ - <a href="doc/methods.md#api_nan_set_prototype_method"><b><code>Nan::SetPrototypeMethod()</code></b></a>
104
+ - <a href="doc/methods.md#api_nan_set_accessor"><b><code>Nan::SetAccessor()</code></b></a>
105
+ - <a href="doc/methods.md#api_nan_set_named_property_handler"><b><code>Nan::SetNamedPropertyHandler()</code></b></a>
106
+ - <a href="doc/methods.md#api_nan_set_indexed_property_handler"><b><code>Nan::SetIndexedPropertyHandler()</code></b></a>
107
+ - <a href="doc/methods.md#api_nan_set_template"><b><code>Nan::SetTemplate()</code></b></a>
108
+ - <a href="doc/methods.md#api_nan_set_prototype_template"><b><code>Nan::SetPrototypeTemplate()</code></b></a>
109
+ - <a href="doc/methods.md#api_nan_set_instance_template"><b><code>Nan::SetInstanceTemplate()</code></b></a>
110
+ - <a href="doc/methods.md#api_nan_set_call_handler"><b><code>Nan::SetCallHandler()</code></b></a>
111
+ - <a href="doc/methods.md#api_nan_set_call_as_function_handler"><b><code>Nan::SetCallAsFunctionHandler()</code></b></a>
112
+
113
+### Scopes
114
+
115
+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.
116
+
117
+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.
118
+
119
+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.
120
+
121
+ - <a href="doc/scopes.md#api_nan_handle_scope"><b><code>Nan::HandleScope</code></b></a>
122
+ - <a href="doc/scopes.md#api_nan_escapable_handle_scope"><b><code>Nan::EscapableHandleScope</code></b></a>
123
+
124
+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).
125
+
126
+### Persistent references
127
+
128
+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.
129
+
130
+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.
131
+
132
+ - <a href="doc/persistent.md#api_nan_persistent_base"><b><code>Nan::PersistentBase & v8::PersistentBase</code></b></a>
133
+ - <a href="doc/persistent.md#api_nan_non_copyable_persistent_traits"><b><code>Nan::NonCopyablePersistentTraits & v8::NonCopyablePersistentTraits</code></b></a>
134
+ - <a href="doc/persistent.md#api_nan_copyable_persistent_traits"><b><code>Nan::CopyablePersistentTraits & v8::CopyablePersistentTraits</code></b></a>
135
+ - <a href="doc/persistent.md#api_nan_persistent"><b><code>Nan::Persistent</code></b></a>
136
+ - <a href="doc/persistent.md#api_nan_global"><b><code>Nan::Global</code></b></a>
137
+ - <a href="doc/persistent.md#api_nan_weak_callback_info"><b><code>Nan::WeakCallbackInfo</code></b></a>
138
+ - <a href="doc/persistent.md#api_nan_weak_callback_type"><b><code>Nan::WeakCallbackType</code></b></a>
139
+
140
+Also see the V8 Embedders Guide section on [Handles and Garbage Collection](https://developers.google.com/v8/embed#handles).
141
+
142
+### New
143
+
144
+NAN provides a `Nan::New()` helper for the creation of new JavaScript objects in a way that's compatible across the supported versions of V8.
145
+
146
+ - <a href="doc/new.md#api_nan_new"><b><code>Nan::New()</code></b></a>
147
+ - <a href="doc/new.md#api_nan_undefined"><b><code>Nan::Undefined()</code></b></a>
148
+ - <a href="doc/new.md#api_nan_null"><b><code>Nan::Null()</code></b></a>
149
+ - <a href="doc/new.md#api_nan_true"><b><code>Nan::True()</code></b></a>
150
+ - <a href="doc/new.md#api_nan_false"><b><code>Nan::False()</code></b></a>
151
+ - <a href="doc/new.md#api_nan_empty_string"><b><code>Nan::EmptyString()</code></b></a>
152
+
153
+
154
+### Converters
155
+
156
+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.
157
+
158
+ - <a href="doc/converters.md#api_nan_to"><b><code>Nan::To()</code></b></a>
159
+
160
+### Maybe Types
161
+
162
+The `Nan::MaybeLocal` and `Nan::Maybe` types are monads that encapsulate `v8::Local` handles that _may be empty_.
163
+
164
+* **Maybe Types**
165
+  - <a href="doc/maybe_types.md#api_nan_maybe_local"><b><code>Nan::MaybeLocal</code></b></a>
166
+  - <a href="doc/maybe_types.md#api_nan_maybe"><b><code>Nan::Maybe</code></b></a>
167
+  - <a href="doc/maybe_types.md#api_nan_nothing"><b><code>Nan::Nothing</code></b></a>
168
+  - <a href="doc/maybe_types.md#api_nan_just"><b><code>Nan::Just</code></b></a>
169
+* **Maybe Helpers**
170
+  - <a href="doc/maybe_types.md#api_nan_call"><b><code>Nan::Call()</code></b></a>
171
+  - <a href="doc/maybe_types.md#api_nan_to_detail_string"><b><code>Nan::ToDetailString()</code></b></a>
172
+  - <a href="doc/maybe_types.md#api_nan_to_array_index"><b><code>Nan::ToArrayIndex()</code></b></a>
173
+  - <a href="doc/maybe_types.md#api_nan_equals"><b><code>Nan::Equals()</code></b></a>
174
+  - <a href="doc/maybe_types.md#api_nan_new_instance"><b><code>Nan::NewInstance()</code></b></a>
175
+  - <a href="doc/maybe_types.md#api_nan_get_function"><b><code>Nan::GetFunction()</code></b></a>
176
+  - <a href="doc/maybe_types.md#api_nan_set"><b><code>Nan::Set()</code></b></a>
177
+  - <a href="doc/maybe_types.md#api_nan_define_own_property"><b><code>Nan::DefineOwnProperty()</code></b></a>
178
+  - <a href="doc/maybe_types.md#api_nan_force_set"><del><b><code>Nan::ForceSet()</code></b></del></a>
179
+  - <a href="doc/maybe_types.md#api_nan_get"><b><code>Nan::Get()</code></b></a>
180
+  - <a href="doc/maybe_types.md#api_nan_get_property_attribute"><b><code>Nan::GetPropertyAttributes()</code></b></a>
181
+  - <a href="doc/maybe_types.md#api_nan_has"><b><code>Nan::Has()</code></b></a>
182
+  - <a href="doc/maybe_types.md#api_nan_delete"><b><code>Nan::Delete()</code></b></a>
183
+  - <a href="doc/maybe_types.md#api_nan_get_property_names"><b><code>Nan::GetPropertyNames()</code></b></a>
184
+  - <a href="doc/maybe_types.md#api_nan_get_own_property_names"><b><code>Nan::GetOwnPropertyNames()</code></b></a>
185
+  - <a href="doc/maybe_types.md#api_nan_set_prototype"><b><code>Nan::SetPrototype()</code></b></a>
186
+  - <a href="doc/maybe_types.md#api_nan_object_proto_to_string"><b><code>Nan::ObjectProtoToString()</code></b></a>
187
+  - <a href="doc/maybe_types.md#api_nan_has_own_property"><b><code>Nan::HasOwnProperty()</code></b></a>
188
+  - <a href="doc/maybe_types.md#api_nan_has_real_named_property"><b><code>Nan::HasRealNamedProperty()</code></b></a>
189
+  - <a href="doc/maybe_types.md#api_nan_has_real_indexed_property"><b><code>Nan::HasRealIndexedProperty()</code></b></a>
190
+  - <a href="doc/maybe_types.md#api_nan_has_real_named_callback_property"><b><code>Nan::HasRealNamedCallbackProperty()</code></b></a>
191
+  - <a href="doc/maybe_types.md#api_nan_get_real_named_property_in_prototype_chain"><b><code>Nan::GetRealNamedPropertyInPrototypeChain()</code></b></a>
192
+  - <a href="doc/maybe_types.md#api_nan_get_real_named_property"><b><code>Nan::GetRealNamedProperty()</code></b></a>
193
+  - <a href="doc/maybe_types.md#api_nan_call_as_function"><b><code>Nan::CallAsFunction()</code></b></a>
194
+  - <a href="doc/maybe_types.md#api_nan_call_as_constructor"><b><code>Nan::CallAsConstructor()</code></b></a>
195
+  - <a href="doc/maybe_types.md#api_nan_get_source_line"><b><code>Nan::GetSourceLine()</code></b></a>
196
+  - <a href="doc/maybe_types.md#api_nan_get_line_number"><b><code>Nan::GetLineNumber()</code></b></a>
197
+  - <a href="doc/maybe_types.md#api_nan_get_start_column"><b><code>Nan::GetStartColumn()</code></b></a>
198
+  - <a href="doc/maybe_types.md#api_nan_get_end_column"><b><code>Nan::GetEndColumn()</code></b></a>
199
+  - <a href="doc/maybe_types.md#api_nan_clone_element_at"><b><code>Nan::CloneElementAt()</code></b></a>
200
+  - <a href="doc/maybe_types.md#api_nan_has_private"><b><code>Nan::HasPrivate()</code></b></a>
201
+  - <a href="doc/maybe_types.md#api_nan_get_private"><b><code>Nan::GetPrivate()</code></b></a>
202
+  - <a href="doc/maybe_types.md#api_nan_set_private"><b><code>Nan::SetPrivate()</code></b></a>
203
+  - <a href="doc/maybe_types.md#api_nan_delete_private"><b><code>Nan::DeletePrivate()</code></b></a>
204
+  - <a href="doc/maybe_types.md#api_nan_make_maybe"><b><code>Nan::MakeMaybe()</code></b></a>
205
+
206
+### Script
207
+
208
+NAN provides `v8::Script` helpers as the API has changed over the supported versions of V8.
209
+
210
+ - <a href="doc/script.md#api_nan_compile_script"><b><code>Nan::CompileScript()</code></b></a>
211
+ - <a href="doc/script.md#api_nan_run_script"><b><code>Nan::RunScript()</code></b></a>
212
+ - <a href="doc/script.md#api_nan_script_origin"><b><code>Nan::ScriptOrigin</code></b></a>
213
+
214
+
215
+### JSON
216
+
217
+The _JSON_ object provides the C++ versions of the methods offered by the `JSON` object in javascript. V8 exposes these methods via the `v8::JSON` object.
218
+
219
+ - <a href="doc/json.md#api_nan_json_parse"><b><code>Nan::JSON.Parse</code></b></a>
220
+ - <a href="doc/json.md#api_nan_json_stringify"><b><code>Nan::JSON.Stringify</code></b></a>
221
+
222
+Refer to the V8 JSON object in the [V8 documentation](https://v8docs.nodesource.com/node-8.16/da/d6f/classv8_1_1_j_s_o_n.html) for more information about these methods and their arguments.
223
+
224
+### Errors
225
+
226
+NAN includes helpers for creating, throwing and catching Errors as much of this functionality varies across the supported versions of V8 and must be abstracted.
227
+
228
+Note that an Error object is simply a specialized form of `v8::Value`.
229
+
230
+Also consult the V8 Embedders Guide section on [Exceptions](https://developers.google.com/v8/embed#exceptions) for more information.
231
+
232
+ - <a href="doc/errors.md#api_nan_error"><b><code>Nan::Error()</code></b></a>
233
+ - <a href="doc/errors.md#api_nan_range_error"><b><code>Nan::RangeError()</code></b></a>
234
+ - <a href="doc/errors.md#api_nan_reference_error"><b><code>Nan::ReferenceError()</code></b></a>
235
+ - <a href="doc/errors.md#api_nan_syntax_error"><b><code>Nan::SyntaxError()</code></b></a>
236
+ - <a href="doc/errors.md#api_nan_type_error"><b><code>Nan::TypeError()</code></b></a>
237
+ - <a href="doc/errors.md#api_nan_throw_error"><b><code>Nan::ThrowError()</code></b></a>
238
+ - <a href="doc/errors.md#api_nan_throw_range_error"><b><code>Nan::ThrowRangeError()</code></b></a>
239
+ - <a href="doc/errors.md#api_nan_throw_reference_error"><b><code>Nan::ThrowReferenceError()</code></b></a>
240
+ - <a href="doc/errors.md#api_nan_throw_syntax_error"><b><code>Nan::ThrowSyntaxError()</code></b></a>
241
+ - <a href="doc/errors.md#api_nan_throw_type_error"><b><code>Nan::ThrowTypeError()</code></b></a>
242
+ - <a href="doc/errors.md#api_nan_fatal_exception"><b><code>Nan::FatalException()</code></b></a>
243
+ - <a href="doc/errors.md#api_nan_errno_exception"><b><code>Nan::ErrnoException()</code></b></a>
244
+ - <a href="doc/errors.md#api_nan_try_catch"><b><code>Nan::TryCatch</code></b></a>
245
+
246
+
247
+### Buffers
248
+
249
+NAN's `node::Buffer` helpers exist as the API has changed across supported Node versions. Use these methods to ensure compatibility.
250
+
251
+ - <a href="doc/buffers.md#api_nan_new_buffer"><b><code>Nan::NewBuffer()</code></b></a>
252
+ - <a href="doc/buffers.md#api_nan_copy_buffer"><b><code>Nan::CopyBuffer()</code></b></a>
253
+ - <a href="doc/buffers.md#api_nan_free_callback"><b><code>Nan::FreeCallback()</code></b></a>
254
+
255
+### Nan::Callback
256
+
257
+`Nan::Callback` makes it easier to use `v8::Function` handles as callbacks. A class that wraps a `v8::Function` handle, protecting it from garbage collection and making it particularly useful for storage and use across asynchronous execution.
258
+
259
+ - <a href="doc/callback.md#api_nan_callback"><b><code>Nan::Callback</code></b></a>
260
+
261
+### Asynchronous work helpers
262
+
263
+`Nan::AsyncWorker`, `Nan::AsyncProgressWorker` and `Nan::AsyncProgressQueueWorker` are helper classes that make working with asynchronous code easier.
264
+
265
+ - <a href="doc/asyncworker.md#api_nan_async_worker"><b><code>Nan::AsyncWorker</code></b></a>
266
+ - <a href="doc/asyncworker.md#api_nan_async_progress_worker"><b><code>Nan::AsyncProgressWorkerBase &amp; Nan::AsyncProgressWorker</code></b></a>
267
+ - <a href="doc/asyncworker.md#api_nan_async_progress_queue_worker"><b><code>Nan::AsyncProgressQueueWorker</code></b></a>
268
+ - <a href="doc/asyncworker.md#api_nan_async_queue_worker"><b><code>Nan::AsyncQueueWorker</code></b></a>
269
+
270
+### Strings & Bytes
271
+
272
+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.
273
+
274
+ - <a href="doc/string_bytes.md#api_nan_encoding"><b><code>Nan::Encoding</code></b></a>
275
+ - <a href="doc/string_bytes.md#api_nan_encode"><b><code>Nan::Encode()</code></b></a>
276
+ - <a href="doc/string_bytes.md#api_nan_decode_bytes"><b><code>Nan::DecodeBytes()</code></b></a>
277
+ - <a href="doc/string_bytes.md#api_nan_decode_write"><b><code>Nan::DecodeWrite()</code></b></a>
278
+
279
+
280
+### Object Wrappers
281
+
282
+The `ObjectWrap` class can be used to make wrapped C++ objects and a factory of wrapped objects.
283
+
284
+ - <a href="doc/object_wrappers.md#api_nan_object_wrap"><b><code>Nan::ObjectWrap</code></b></a>
285
+
286
+
287
+### V8 internals
288
+
289
+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.
290
+
291
+ - <a href="doc/v8_internals.md#api_nan_gc_callback"><b><code>NAN_GC_CALLBACK()</code></b></a>
292
+ - <a href="doc/v8_internals.md#api_nan_add_gc_epilogue_callback"><b><code>Nan::AddGCEpilogueCallback()</code></b></a>
293
+ - <a href="doc/v8_internals.md#api_nan_remove_gc_epilogue_callback"><b><code>Nan::RemoveGCEpilogueCallback()</code></b></a>
294
+ - <a href="doc/v8_internals.md#api_nan_add_gc_prologue_callback"><b><code>Nan::AddGCPrologueCallback()</code></b></a>
295
+ - <a href="doc/v8_internals.md#api_nan_remove_gc_prologue_callback"><b><code>Nan::RemoveGCPrologueCallback()</code></b></a>
296
+ - <a href="doc/v8_internals.md#api_nan_get_heap_statistics"><b><code>Nan::GetHeapStatistics()</code></b></a>
297
+ - <a href="doc/v8_internals.md#api_nan_set_counter_function"><b><code>Nan::SetCounterFunction()</code></b></a>
298
+ - <a href="doc/v8_internals.md#api_nan_set_create_histogram_function"><b><code>Nan::SetCreateHistogramFunction()</code></b></a>
299
+ - <a href="doc/v8_internals.md#api_nan_set_add_histogram_sample_function"><b><code>Nan::SetAddHistogramSampleFunction()</code></b></a>
300
+ - <a href="doc/v8_internals.md#api_nan_idle_notification"><b><code>Nan::IdleNotification()</code></b></a>
301
+ - <a href="doc/v8_internals.md#api_nan_low_memory_notification"><b><code>Nan::LowMemoryNotification()</code></b></a>
302
+ - <a href="doc/v8_internals.md#api_nan_context_disposed_notification"><b><code>Nan::ContextDisposedNotification()</code></b></a>
303
+ - <a href="doc/v8_internals.md#api_nan_get_internal_field_pointer"><b><code>Nan::GetInternalFieldPointer()</code></b></a>
304
+ - <a href="doc/v8_internals.md#api_nan_set_internal_field_pointer"><b><code>Nan::SetInternalFieldPointer()</code></b></a>
305
+ - <a href="doc/v8_internals.md#api_nan_adjust_external_memory"><b><code>Nan::AdjustExternalMemory()</code></b></a>
306
+
307
+
308
+### Miscellaneous V8 Helpers
309
+
310
+ - <a href="doc/v8_misc.md#api_nan_utf8_string"><b><code>Nan::Utf8String</code></b></a>
311
+ - <a href="doc/v8_misc.md#api_nan_get_current_context"><b><code>Nan::GetCurrentContext()</code></b></a>
312
+ - <a href="doc/v8_misc.md#api_nan_set_isolate_data"><b><code>Nan::SetIsolateData()</code></b></a>
313
+ - <a href="doc/v8_misc.md#api_nan_get_isolate_data"><b><code>Nan::GetIsolateData()</code></b></a>
314
+ - <a href="doc/v8_misc.md#api_nan_typedarray_contents"><b><code>Nan::TypedArrayContents</code></b></a>
315
+
316
+
317
+### Miscellaneous Node Helpers
318
+
319
+ - <a href="doc/node_misc.md#api_nan_asyncresource"><b><code>Nan::AsyncResource</code></b></a>
320
+ - <a href="doc/node_misc.md#api_nan_make_callback"><b><code>Nan::MakeCallback()</code></b></a>
321
+ - <a href="doc/node_misc.md#api_nan_module_init"><b><code>NAN_MODULE_INIT()</code></b></a>
322
+ - <a href="doc/node_misc.md#api_nan_export"><b><code>Nan::Export()</code></b></a>
323
+
324
+<!-- END API -->
325
+
326
+
327
+<a name="tests"></a>
328
+
329
+### Tests
330
+
331
+To run the NAN tests do:
332
+
333
+``` sh
334
+npm install
335
+npm run-script rebuild-tests
336
+npm test
337
+```
338
+
339
+Or just:
340
+
341
+``` sh
342
+npm install
343
+make test
344
+```
345
+
346
+<a name="issues"></a>
347
+
348
+## Known issues
349
+
350
+### Compiling against Node.js 0.12 on OSX
351
+
352
+With new enough compilers available on OSX, the versions of V8 headers corresponding to Node.js 0.12
353
+do not compile anymore. The error looks something like:
354
+
355
+```
356
+❯   CXX(target) Release/obj.target/accessors/cpp/accessors.o
357
+In file included from ../cpp/accessors.cpp:9:
358
+In file included from ../../nan.h:51:
359
+In file included from /Users/ofrobots/.node-gyp/0.12.18/include/node/node.h:61:
360
+/Users/ofrobots/.node-gyp/0.12.18/include/node/v8.h:5800:54: error: 'CreateHandle' is a protected member of 'v8::HandleScope'
361
+  return Handle<T>(reinterpret_cast<T*>(HandleScope::CreateHandle(
362
+                                        ~~~~~~~~~~~~~^~~~~~~~~~~~
363
+```
364
+
365
+This can be worked around by patching your local versions of v8.h corresponding to Node 0.12 to make
366
+`v8::Handle` a friend of `v8::HandleScope`. Since neither Node.js not V8 support this release line anymore
367
+this patch cannot be released by either project in an official release.
368
+
369
+For this reason, we do not test against Node.js 0.12 on OSX in this project's CI. If you need to support
370
+that configuration, you will need to either get an older compiler, or apply a source patch to the version
371
+of V8 headers as a workaround.
372
+
373
+<a name="governance"></a>
374
+
375
+## Governance & Contributing
376
+
377
+NAN is governed by the [Node.js Addon API Working Group](https://github.com/nodejs/CTC/blob/master/WORKING_GROUPS.md#addon-api)
378
+
379
+### Addon API Working Group (WG)
380
+
381
+The NAN project is jointly governed by a Working Group which is responsible for high-level guidance of the project.
382
+
383
+Members of the WG are also known as Collaborators, there is no distinction between the two, unlike other Node.js projects.
384
+
385
+The WG has final authority over this project including:
386
+
387
+* Technical direction
388
+* Project governance and process (including this policy)
389
+* Contribution policy
390
+* GitHub repository hosting
391
+* Maintaining the list of additional Collaborators
392
+
393
+For the current list of WG members, see the project [README.md](./README.md#collaborators).
394
+
395
+Individuals making significant and valuable contributions are made members of the WG and given commit-access to the project. These individuals are identified by the WG and their addition to the WG is discussed via GitHub and requires unanimous consensus amongst those WG members participating in the discussion with a quorum of 50% of WG members required for acceptance of the vote.
396
+
397
+_Note:_ If you make a significant contribution and are not considered for commit-access log an issue or contact a WG member directly.
398
+
399
+For the current list of WG members / Collaborators, see the project [README.md](./README.md#collaborators).
400
+
401
+### Consensus Seeking Process
402
+
403
+The WG follows a [Consensus Seeking](https://en.wikipedia.org/wiki/Consensus-seeking_decision-making) decision making model.
404
+
405
+Modifications of the contents of the NAN repository are made on a collaborative basis. Anybody with a GitHub account may propose a modification via pull request and it will be considered by the WG. All pull requests must be reviewed and accepted by a WG member with sufficient expertise who is able to take full responsibility for the change. In the case of pull requests proposed by an existing WG member, an additional WG member is required for sign-off. Consensus should be sought if additional WG members participate and there is disagreement around a particular modification.
406
+
407
+If a change proposal cannot reach a consensus, a WG member can call for a vote amongst the members of the WG. Simple majority wins.
408
+
409
+<a id="developers-certificate-of-origin"></a>
410
+
411
+## Developer's Certificate of Origin 1.1
412
+
413
+By making a contribution to this project, I certify that:
414
+
415
+* (a) The contribution was created in whole or in part by me and I
416
+  have the right to submit it under the open source license
417
+  indicated in the file; or
418
+
419
+* (b) The contribution is based upon previous work that, to the best
420
+  of my knowledge, is covered under an appropriate open source
421
+  license and I have the right under that license to submit that
422
+  work with modifications, whether created in whole or in part
423
+  by me, under the same open source license (unless I am
424
+  permitted to submit under a different license), as indicated
425
+  in the file; or
426
+
427
+* (c) The contribution was provided directly to me by some other
428
+  person who certified (a), (b) or (c) and I have not modified
429
+  it.
430
+
431
+* (d) I understand and agree that this project and the contribution
432
+  are public and that a record of the contribution (including all
433
+  personal information I submit with it, including my sign-off) is
434
+  maintained indefinitely and may be redistributed consistent with
435
+  this project or the open source license(s) involved.
436
+
437
+<a name="collaborators"></a>
438
+
439
+### WG Members / Collaborators
440
+
441
+<table><tbody>
442
+<tr><th align="left">Rod Vagg</th><td><a href="https://github.com/rvagg">GitHub/rvagg</a></td><td><a href="http://twitter.com/rvagg">Twitter/@rvagg</a></td></tr>
443
+<tr><th align="left">Benjamin Byholm</th><td><a href="https://github.com/kkoopa/">GitHub/kkoopa</a></td><td>-</td></tr>
444
+<tr><th align="left">Trevor Norris</th><td><a href="https://github.com/trevnorris">GitHub/trevnorris</a></td><td><a href="http://twitter.com/trevnorris">Twitter/@trevnorris</a></td></tr>
445
+<tr><th align="left">Nathan Rajlich</th><td><a href="https://github.com/TooTallNate">GitHub/TooTallNate</a></td><td><a href="http://twitter.com/TooTallNate">Twitter/@TooTallNate</a></td></tr>
446
+<tr><th align="left">Brett Lawson</th><td><a href="https://github.com/brett19">GitHub/brett19</a></td><td><a href="http://twitter.com/brett19x">Twitter/@brett19x</a></td></tr>
447
+<tr><th align="left">Ben Noordhuis</th><td><a href="https://github.com/bnoordhuis">GitHub/bnoordhuis</a></td><td><a href="http://twitter.com/bnoordhuis">Twitter/@bnoordhuis</a></td></tr>
448
+<tr><th align="left">David Siegel</th><td><a href="https://github.com/agnat">GitHub/agnat</a></td><td><a href="http://twitter.com/agnat">Twitter/@agnat</a></td></tr>
449
+<tr><th align="left">Michael Ira Krufky</th><td><a href="https://github.com/mkrufky">GitHub/mkrufky</a></td><td><a href="http://twitter.com/mkrufky">Twitter/@mkrufky</a></td></tr>
450
+</tbody></table>
451
+
452
+## Licence &amp; copyright
453
+
454
+Copyright (c) 2018 NAN WG Members / Collaborators (listed above).
455
+
456
+Native Abstractions for Node.js is licensed under an MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.
... ...
@@ -0,0 +1,146 @@
1
+## Asynchronous work helpers
2
+
3
+`Nan::AsyncWorker`, `Nan::AsyncProgressWorker` and `Nan::AsyncProgressQueueWorker` are helper classes that make working with asynchronous code easier.
4
+
5
+ - <a href="#api_nan_async_worker"><b><code>Nan::AsyncWorker</code></b></a>
6
+ - <a href="#api_nan_async_progress_worker"><b><code>Nan::AsyncProgressWorkerBase &amp; Nan::AsyncProgressWorker</code></b></a>
7
+ - <a href="#api_nan_async_progress_queue_worker"><b><code>Nan::AsyncProgressQueueWorker</code></b></a>
8
+ - <a href="#api_nan_async_queue_worker"><b><code>Nan::AsyncQueueWorker</code></b></a>
9
+
10
+<a name="api_nan_async_worker"></a>
11
+### Nan::AsyncWorker
12
+
13
+`Nan::AsyncWorker` is an _abstract_ class that you can subclass to have much of the annoying asynchronous queuing and handling taken care of for you. It can even store arbitrary V8 objects for you and have them persist while the asynchronous work is in progress.
14
+
15
+This class internally handles the details of creating an [`AsyncResource`][AsyncResource], and running the callback in the
16
+correct async context. To be able to identify the async resources created by this class in async-hooks, provide a
17
+`resource_name` to the constructor. It is recommended that the module name be used as a prefix to the `resource_name` to avoid
18
+collisions in the names. For more details see [`AsyncResource`][AsyncResource] documentation.  The `resource_name` needs to stay valid for the lifetime of the worker instance.
19
+
20
+Definition:
21
+
22
+```c++
23
+class AsyncWorker {
24
+ public:
25
+  explicit AsyncWorker(Callback *callback_, const char* resource_name = "nan:AsyncWorker");
26
+
27
+  virtual ~AsyncWorker();
28
+
29
+  virtual void WorkComplete();
30
+
31
+  void SaveToPersistent(const char *key, const v8::Local<v8::Value> &value);
32
+
33
+  void SaveToPersistent(const v8::Local<v8::String> &key,
34
+                        const v8::Local<v8::Value> &value);
35
+
36
+  void SaveToPersistent(uint32_t index,
37
+                        const v8::Local<v8::Value> &value);
38
+
39
+  v8::Local<v8::Value> GetFromPersistent(const char *key) const;
40
+
41
+  v8::Local<v8::Value> GetFromPersistent(const v8::Local<v8::String> &key) const;
42
+
43
+  v8::Local<v8::Value> GetFromPersistent(uint32_t index) const;
44
+
45
+  virtual void Execute() = 0;
46
+
47
+  uv_work_t request;
48
+
49
+  virtual void Destroy();
50
+
51
+ protected:
52
+  Persistent<v8::Object> persistentHandle;
53
+
54
+  Callback *callback;
55
+
56
+  virtual void HandleOKCallback();
57
+
58
+  virtual void HandleErrorCallback();
59
+
60
+  void SetErrorMessage(const char *msg);
61
+
62
+  const char* ErrorMessage();
63
+};
64
+```
65
+
66
+<a name="api_nan_async_progress_worker"></a>
67
+### Nan::AsyncProgressWorkerBase &amp; Nan::AsyncProgressWorker
68
+
69
+`Nan::AsyncProgressWorkerBase` is an _abstract_ class template that extends `Nan::AsyncWorker` and adds additional progress reporting callbacks that can be used during the asynchronous work execution to provide progress data back to JavaScript.
70
+
71
+Previously the definition of `Nan::AsyncProgressWorker` only allowed sending `const char` data. Now extending `Nan::AsyncProgressWorker` will yield an instance of the implicit `Nan::AsyncProgressWorkerBase` template with type `<char>` for compatibility.
72
+
73
+`Nan::AsyncProgressWorkerBase` &amp; `Nan::AsyncProgressWorker` is intended for best-effort delivery of nonessential progress messages, e.g. a progress bar.  The last event sent before the main thread is woken will be delivered.
74
+
75
+Definition:
76
+
77
+```c++
78
+template<class T>
79
+class AsyncProgressWorkerBase<T> : public AsyncWorker {
80
+ public:
81
+  explicit AsyncProgressWorkerBase(Callback *callback_, const char* resource_name = ...);
82
+
83
+  virtual ~AsyncProgressWorkerBase();
84
+
85
+  void WorkProgress();
86
+
87
+  class ExecutionProgress {
88
+   public:
89
+    void Signal() const;
90
+    void Send(const T* data, size_t count) const;
91
+  };
92
+
93
+  virtual void Execute(const ExecutionProgress& progress) = 0;
94
+
95
+  virtual void HandleProgressCallback(const T *data, size_t count) = 0;
96
+
97
+  virtual void Destroy();
98
+};
99
+
100
+typedef AsyncProgressWorkerBase<T> AsyncProgressWorker;
101
+```
102
+
103
+<a name="api_nan_async_progress_queue_worker"></a>
104
+### Nan::AsyncProgressQueueWorker
105
+
106
+`Nan::AsyncProgressQueueWorker` is an _abstract_ class template that extends `Nan::AsyncWorker` and adds additional progress reporting callbacks that can be used during the asynchronous work execution to provide progress data back to JavaScript.
107
+
108
+`Nan::AsyncProgressQueueWorker` behaves exactly the same as `Nan::AsyncProgressWorker`, except all events are queued and delivered to the main thread.
109
+
110
+Definition:
111
+
112
+```c++
113
+template<class T>
114
+class AsyncProgressQueueWorker<T> : public AsyncWorker {
115
+ public:
116
+  explicit AsyncProgressQueueWorker(Callback *callback_, const char* resource_name = "nan:AsyncProgressQueueWorker");
117
+
118
+  virtual ~AsyncProgressQueueWorker();
119
+
120
+  void WorkProgress();
121
+
122
+  class ExecutionProgress {
123
+   public:
124
+    void Send(const T* data, size_t count) const;
125
+  };
126
+
127
+  virtual void Execute(const ExecutionProgress& progress) = 0;
128
+
129
+  virtual void HandleProgressCallback(const T *data, size_t count) = 0;
130
+
131
+  virtual void Destroy();
132
+};
133
+```
134
+
135
+<a name="api_nan_async_queue_worker"></a>
136
+### Nan::AsyncQueueWorker
137
+
138
+`Nan::AsyncQueueWorker` will run a `Nan::AsyncWorker` asynchronously via libuv. Both the `execute` and `after_work` steps are taken care of for you. Most of the logic for this is embedded in `Nan::AsyncWorker`.
139
+
140
+Definition:
141
+
142
+```c++
143
+void AsyncQueueWorker(AsyncWorker *);
144
+```
145
+
146
+[AsyncResource]: node_misc.md#api_nan_asyncresource
... ...
@@ -0,0 +1,54 @@
1
+## Buffers
2
+
3
+NAN's `node::Buffer` helpers exist as the API has changed across supported Node versions. Use these methods to ensure compatibility.
4
+
5
+ - <a href="#api_nan_new_buffer"><b><code>Nan::NewBuffer()</code></b></a>
6
+ - <a href="#api_nan_copy_buffer"><b><code>Nan::CopyBuffer()</code></b></a>
7
+ - <a href="#api_nan_free_callback"><b><code>Nan::FreeCallback()</code></b></a>
8
+
9
+<a name="api_nan_new_buffer"></a>
10
+### Nan::NewBuffer()
11
+
12
+Allocate a new `node::Buffer` object with the specified size and optional data. Calls `node::Buffer::New()`.
13
+
14
+Note that when creating a `Buffer` using `Nan::NewBuffer()` and an existing `char*`, it is assumed that the ownership of the pointer is being transferred to the new `Buffer` for management.
15
+When a `node::Buffer` instance is garbage collected and a `FreeCallback` has not been specified, `data` will be disposed of via a call to `free()`.
16
+You _must not_ free the memory space manually once you have created a `Buffer` in this way.
17
+
18
+Signature:
19
+
20
+```c++
21
+Nan::MaybeLocal<v8::Object> Nan::NewBuffer(uint32_t size)
22
+Nan::MaybeLocal<v8::Object> Nan::NewBuffer(char* data, uint32_t size)
23
+Nan::MaybeLocal<v8::Object> Nan::NewBuffer(char *data,
24
+                                           size_t length,
25
+                                           Nan::FreeCallback callback,
26
+                                           void *hint)
27
+```
28
+
29
+
30
+<a name="api_nan_copy_buffer"></a>
31
+### Nan::CopyBuffer()
32
+
33
+Similar to [`Nan::NewBuffer()`](#api_nan_new_buffer) except that an implicit memcpy will occur within Node. Calls `node::Buffer::Copy()`.
34
+
35
+Management of the `char*` is left to the user, you should manually free the memory space if necessary as the new `Buffer` will have its own copy.
36
+
37
+Signature:
38
+
39
+```c++
40
+Nan::MaybeLocal<v8::Object> Nan::CopyBuffer(const char *data, uint32_t size)
41
+```
42
+
43
+
44
+<a name="api_nan_free_callback"></a>
45
+### Nan::FreeCallback()
46
+
47
+A free callback that can be provided to [`Nan::NewBuffer()`](#api_nan_new_buffer).
48
+The supplied callback will be invoked when the `Buffer` undergoes garbage collection.
49
+
50
+Signature:
51
+
52
+```c++
53
+typedef void (*FreeCallback)(char *data, void *hint);
54
+```
... ...
@@ -0,0 +1,76 @@
1
+## Nan::Callback
2
+
3
+`Nan::Callback` makes it easier to use `v8::Function` handles as callbacks. A class that wraps a `v8::Function` handle, protecting it from garbage collection and making it particularly useful for storage and use across asynchronous execution.
4
+
5
+ - <a href="#api_nan_callback"><b><code>Nan::Callback</code></b></a>
6
+
7
+<a name="api_nan_callback"></a>
8
+### Nan::Callback
9
+
10
+```c++
11
+class Callback {
12
+ public:
13
+  Callback();
14
+
15
+  explicit Callback(const v8::Local<v8::Function> &fn);
16
+
17
+  ~Callback();
18
+
19
+  bool operator==(const Callback &other) const;
20
+
21
+  bool operator!=(const Callback &other) const;
22
+
23
+  v8::Local<v8::Function> operator*() const;
24
+
25
+  MaybeLocal<v8::Value> operator()(AsyncResource* async_resource,
26
+                                   v8::Local<v8::Object> target,
27
+                                   int argc = 0,
28
+                                   v8::Local<v8::Value> argv[] = 0) const;
29
+
30
+  MaybeLocal<v8::Value> operator()(AsyncResource* async_resource,
31
+                                   int argc = 0,
32
+                                   v8::Local<v8::Value> argv[] = 0) const;
33
+
34
+  void SetFunction(const v8::Local<v8::Function> &fn);
35
+
36
+  v8::Local<v8::Function> GetFunction() const;
37
+
38
+  bool IsEmpty() const;
39
+
40
+  void Reset(const v8::Local<v8::Function> &fn);
41
+
42
+  void Reset();
43
+
44
+  MaybeLocal<v8::Value> Call(v8::Local<v8::Object> target,
45
+                            int argc,
46
+                            v8::Local<v8::Value> argv[],
47
+                            AsyncResource* async_resource) const;
48
+  MaybeLocal<v8::Value> Call(int argc,
49
+                             v8::Local<v8::Value> argv[],
50
+                             AsyncResource* async_resource) const;
51
+
52
+  // Deprecated versions. Use the versions that accept an async_resource instead
53
+  // as they run the callback in the correct async context as specified by the
54
+  // resource. If you want to call a synchronous JS function (i.e. on a
55
+  // non-empty JS stack), you can use Nan::Call instead.
56
+  v8::Local<v8::Value> operator()(v8::Local<v8::Object> target,
57
+                                  int argc = 0,
58
+                                  v8::Local<v8::Value> argv[] = 0) const;
59
+
60
+  v8::Local<v8::Value> operator()(int argc = 0,
61
+                                  v8::Local<v8::Value> argv[] = 0) const;
62
+  v8::Local<v8::Value> Call(v8::Local<v8::Object> target,
63
+                            int argc,
64
+                            v8::Local<v8::Value> argv[]) const;
65
+
66
+  v8::Local<v8::Value> Call(int argc, v8::Local<v8::Value> argv[]) const;
67
+};
68
+```
69
+
70
+Example usage:
71
+
72
+```c++
73
+v8::Local<v8::Function> function;
74
+Nan::Callback callback(function);
75
+callback.Call(0, 0);
76
+```
... ...
@@ -0,0 +1,41 @@
1
+## Converters
2
+
3
+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.
4
+
5
+ - <a href="#api_nan_to"><b><code>Nan::To()</code></b></a>
6
+
7
+<a name="api_nan_to"></a>
8
+### Nan::To()
9
+
10
+Converts a `v8::Local<v8::Value>` to a different subtype of `v8::Value` or to a native data type. Returns a `Nan::MaybeLocal<>` or a `Nan::Maybe<>` accordingly.
11
+
12
+See [maybe_types.md](./maybe_types.md) for more information on `Nan::Maybe` types.
13
+
14
+Signatures:
15
+
16
+```c++
17
+// V8 types
18
+Nan::MaybeLocal<v8::Boolean> Nan::To<v8::Boolean>(v8::Local<v8::Value> val);
19
+Nan::MaybeLocal<v8::Int32> Nan::To<v8::Int32>(v8::Local<v8::Value> val);
20
+Nan::MaybeLocal<v8::Integer> Nan::To<v8::Integer>(v8::Local<v8::Value> val);
21
+Nan::MaybeLocal<v8::Object> Nan::To<v8::Object>(v8::Local<v8::Value> val);
22
+Nan::MaybeLocal<v8::Number> Nan::To<v8::Number>(v8::Local<v8::Value> val);
23
+Nan::MaybeLocal<v8::String> Nan::To<v8::String>(v8::Local<v8::Value> val);
24
+Nan::MaybeLocal<v8::Uint32> Nan::To<v8::Uint32>(v8::Local<v8::Value> val);
25
+
26
+// Native types
27
+Nan::Maybe<bool> Nan::To<bool>(v8::Local<v8::Value> val);
28
+Nan::Maybe<double> Nan::To<double>(v8::Local<v8::Value> val);
29
+Nan::Maybe<int32_t> Nan::To<int32_t>(v8::Local<v8::Value> val);
30
+Nan::Maybe<int64_t> Nan::To<int64_t>(v8::Local<v8::Value> val);
31
+Nan::Maybe<uint32_t> Nan::To<uint32_t>(v8::Local<v8::Value> val);
32
+```
33
+
34
+### Example
35
+
36
+```c++
37
+v8::Local<v8::Value> val;
38
+Nan::MaybeLocal<v8::String> str = Nan::To<v8::String>(val);
39
+Nan::Maybe<double> d = Nan::To<double>(val);
40
+```
41
+
... ...
@@ -0,0 +1,226 @@
1
+## Errors
2
+
3
+NAN includes helpers for creating, throwing and catching Errors as much of this functionality varies across the supported versions of V8 and must be abstracted.
4
+
5
+Note that an Error object is simply a specialized form of `v8::Value`.
6
+
7
+Also consult the V8 Embedders Guide section on [Exceptions](https://developers.google.com/v8/embed#exceptions) for more information.
8
+
9
+ - <a href="#api_nan_error"><b><code>Nan::Error()</code></b></a>
10
+ - <a href="#api_nan_range_error"><b><code>Nan::RangeError()</code></b></a>
11
+ - <a href="#api_nan_reference_error"><b><code>Nan::ReferenceError()</code></b></a>
12
+ - <a href="#api_nan_syntax_error"><b><code>Nan::SyntaxError()</code></b></a>
13
+ - <a href="#api_nan_type_error"><b><code>Nan::TypeError()</code></b></a>
14
+ - <a href="#api_nan_throw_error"><b><code>Nan::ThrowError()</code></b></a>
15
+ - <a href="#api_nan_throw_range_error"><b><code>Nan::ThrowRangeError()</code></b></a>
16
+ - <a href="#api_nan_throw_reference_error"><b><code>Nan::ThrowReferenceError()</code></b></a>
17
+ - <a href="#api_nan_throw_syntax_error"><b><code>Nan::ThrowSyntaxError()</code></b></a>
18
+ - <a href="#api_nan_throw_type_error"><b><code>Nan::ThrowTypeError()</code></b></a>
19
+ - <a href="#api_nan_fatal_exception"><b><code>Nan::FatalException()</code></b></a>
20
+ - <a href="#api_nan_errno_exception"><b><code>Nan::ErrnoException()</code></b></a>
21
+ - <a href="#api_nan_try_catch"><b><code>Nan::TryCatch</code></b></a>
22
+
23
+
24
+<a name="api_nan_error"></a>
25
+### Nan::Error()
26
+
27
+Create a new Error object using the [v8::Exception](https://v8docs.nodesource.com/node-8.16/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
28
+
29
+Note that an Error object is simply a specialized form of `v8::Value`.
30
+
31
+Signature:
32
+
33
+```c++
34
+v8::Local<v8::Value> Nan::Error(const char *msg);
35
+v8::Local<v8::Value> Nan::Error(v8::Local<v8::String> msg);
36
+```
37
+
38
+
39
+<a name="api_nan_range_error"></a>
40
+### Nan::RangeError()
41
+
42
+Create a new RangeError object using the [v8::Exception](https://v8docs.nodesource.com/node-8.16/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
43
+
44
+Note that an RangeError object is simply a specialized form of `v8::Value`.
45
+
46
+Signature:
47
+
48
+```c++
49
+v8::Local<v8::Value> Nan::RangeError(const char *msg);
50
+v8::Local<v8::Value> Nan::RangeError(v8::Local<v8::String> msg);
51
+```
52
+
53
+
54
+<a name="api_nan_reference_error"></a>
55
+### Nan::ReferenceError()
56
+
57
+Create a new ReferenceError object using the [v8::Exception](https://v8docs.nodesource.com/node-8.16/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
58
+
59
+Note that an ReferenceError object is simply a specialized form of `v8::Value`.
60
+
61
+Signature:
62
+
63
+```c++
64
+v8::Local<v8::Value> Nan::ReferenceError(const char *msg);
65
+v8::Local<v8::Value> Nan::ReferenceError(v8::Local<v8::String> msg);
66
+```
67
+
68
+
69
+<a name="api_nan_syntax_error"></a>
70
+### Nan::SyntaxError()
71
+
72
+Create a new SyntaxError object using the [v8::Exception](https://v8docs.nodesource.com/node-8.16/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
73
+
74
+Note that an SyntaxError object is simply a specialized form of `v8::Value`.
75
+
76
+Signature:
77
+
78
+```c++
79
+v8::Local<v8::Value> Nan::SyntaxError(const char *msg);
80
+v8::Local<v8::Value> Nan::SyntaxError(v8::Local<v8::String> msg);
81
+```
82
+
83
+
84
+<a name="api_nan_type_error"></a>
85
+### Nan::TypeError()
86
+
87
+Create a new TypeError object using the [v8::Exception](https://v8docs.nodesource.com/node-8.16/da/d6a/classv8_1_1_exception.html) class in a way that is compatible across the supported versions of V8.
88
+
89
+Note that an TypeError object is simply a specialized form of `v8::Value`.
90
+
91
+Signature:
92
+
93
+```c++
94
+v8::Local<v8::Value> Nan::TypeError(const char *msg);
95
+v8::Local<v8::Value> Nan::TypeError(v8::Local<v8::String> msg);
96
+```
97
+
98
+
99
+<a name="api_nan_throw_error"></a>
100
+### Nan::ThrowError()
101
+
102
+Throw an Error object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new Error object will be created.
103
+
104
+Signature:
105
+
106
+```c++
107
+void Nan::ThrowError(const char *msg);
108
+void Nan::ThrowError(v8::Local<v8::String> msg);
109
+void Nan::ThrowError(v8::Local<v8::Value> error);
110
+```
111
+
112
+
113
+<a name="api_nan_throw_range_error"></a>
114
+### Nan::ThrowRangeError()
115
+
116
+Throw an RangeError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new RangeError object will be created.
117
+
118
+Signature:
119
+
120
+```c++
121
+void Nan::ThrowRangeError(const char *msg);
122
+void Nan::ThrowRangeError(v8::Local<v8::String> msg);
123
+void Nan::ThrowRangeError(v8::Local<v8::Value> error);
124
+```
125
+
126
+
127
+<a name="api_nan_throw_reference_error"></a>
128
+### Nan::ThrowReferenceError()
129
+
130
+Throw an ReferenceError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new ReferenceError object will be created.
131
+
132
+Signature:
133
+
134
+```c++
135
+void Nan::ThrowReferenceError(const char *msg);
136
+void Nan::ThrowReferenceError(v8::Local<v8::String> msg);
137
+void Nan::ThrowReferenceError(v8::Local<v8::Value> error);
138
+```
139
+
140
+
141
+<a name="api_nan_throw_syntax_error"></a>
142
+### Nan::ThrowSyntaxError()
143
+
144
+Throw an SyntaxError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new SyntaxError object will be created.
145
+
146
+Signature:
147
+
148
+```c++
149
+void Nan::ThrowSyntaxError(const char *msg);
150
+void Nan::ThrowSyntaxError(v8::Local<v8::String> msg);
151
+void Nan::ThrowSyntaxError(v8::Local<v8::Value> error);
152
+```
153
+
154
+
155
+<a name="api_nan_throw_type_error"></a>
156
+### Nan::ThrowTypeError()
157
+
158
+Throw an TypeError object (a specialized `v8::Value` as above) in the current context. If a `msg` is provided, a new TypeError object will be created.
159
+
160
+Signature:
161
+
162
+```c++
163
+void Nan::ThrowTypeError(const char *msg);
164
+void Nan::ThrowTypeError(v8::Local<v8::String> msg);
165
+void Nan::ThrowTypeError(v8::Local<v8::Value> error);
166
+```
167
+
168
+<a name="api_nan_fatal_exception"></a>
169
+### Nan::FatalException()
170
+
171
+Replaces `node::FatalException()` which has a different API across supported versions of Node. For use with [`Nan::TryCatch`](#api_nan_try_catch).
172
+
173
+Signature:
174
+
175
+```c++
176
+void Nan::FatalException(const Nan::TryCatch& try_catch);
177
+```
178
+
179
+<a name="api_nan_errno_exception"></a>
180
+### Nan::ErrnoException()
181
+
182
+Replaces `node::ErrnoException()` which has a different API across supported versions of Node. 
183
+
184
+Signature:
185
+
186
+```c++
187
+v8::Local<v8::Value> Nan::ErrnoException(int errorno,
188
+                                         const char* syscall = NULL,
189
+                                         const char* message = NULL,
190
+                                         const char* path = NULL);
191
+```
192
+
193
+
194
+<a name="api_nan_try_catch"></a>
195
+### Nan::TryCatch
196
+
197
+A simple wrapper around [`v8::TryCatch`](https://v8docs.nodesource.com/node-8.16/d4/dc6/classv8_1_1_try_catch.html) compatible with all supported versions of V8. Can be used as a direct replacement in most cases. See also [`Nan::FatalException()`](#api_nan_fatal_exception) for an internal use compatible with `node::FatalException`.
198
+
199
+Signature:
200
+
201
+```c++
202
+class Nan::TryCatch {
203
+ public:
204
+  Nan::TryCatch();
205
+
206
+  bool HasCaught() const;
207
+
208
+  bool CanContinue() const;
209
+
210
+  v8::Local<v8::Value> ReThrow();
211
+
212
+  v8::Local<v8::Value> Exception() const;
213
+
214
+  // Nan::MaybeLocal for older versions of V8
215
+  v8::MaybeLocal<v8::Value> StackTrace() const;
216
+
217
+  v8::Local<v8::Message> Message() const;
218
+
219
+  void Reset();
220
+
221
+  void SetVerbose(bool value);
222
+
223
+  void SetCaptureMessage(bool value);
224
+};
225
+```
226
+
... ...
@@ -0,0 +1,62 @@
1
+## JSON
2
+
3
+The _JSON_ object provides the C++ versions of the methods offered by the `JSON` object in javascript. V8 exposes these methods via the `v8::JSON` object.
4
+
5
+ - <a href="#api_nan_json_parse"><b><code>Nan::JSON.Parse</code></b></a>
6
+ - <a href="#api_nan_json_stringify"><b><code>Nan::JSON.Stringify</code></b></a>
7
+
8
+Refer to the V8 JSON object in the [V8 documentation](https://v8docs.nodesource.com/node-8.16/da/d6f/classv8_1_1_j_s_o_n.html) for more information about these methods and their arguments.
9
+
10
+<a name="api_nan_json_parse"></a>
11
+
12
+### Nan::JSON.Parse
13
+
14
+A simple wrapper around [`v8::JSON::Parse`](https://v8docs.nodesource.com/node-8.16/da/d6f/classv8_1_1_j_s_o_n.html#a936310d2540fb630ed37d3ee3ffe4504).
15
+
16
+Definition:
17
+
18
+```c++
19
+Nan::MaybeLocal<v8::Value> Nan::JSON::Parse(v8::Local<v8::String> json_string);
20
+```
21
+
22
+Use `JSON.Parse(json_string)` to parse a string into a `v8::Value`.
23
+
24
+Example:
25
+
26
+```c++
27
+v8::Local<v8::String> json_string = Nan::New("{ \"JSON\": \"object\" }").ToLocalChecked();
28
+
29
+Nan::JSON NanJSON;
30
+Nan::MaybeLocal<v8::Value> result = NanJSON.Parse(json_string);
31
+if (!result.IsEmpty()) {
32
+  v8::Local<v8::Value> val = result.ToLocalChecked();
33
+}
34
+```
35
+
36
+<a name="api_nan_json_stringify"></a>
37
+
38
+### Nan::JSON.Stringify
39
+
40
+A simple wrapper around [`v8::JSON::Stringify`](https://v8docs.nodesource.com/node-8.16/da/d6f/classv8_1_1_j_s_o_n.html#a44b255c3531489ce43f6110209138860).
41
+
42
+Definition:
43
+
44
+```c++
45
+Nan::MaybeLocal<v8::String> Nan::JSON::Stringify(v8::Local<v8::Object> json_object, v8::Local<v8::String> gap = v8::Local<v8::String>());
46
+```
47
+
48
+Use `JSON.Stringify(value)` to stringify a `v8::Object`.
49
+
50
+Example:
51
+
52
+```c++
53
+// using `v8::Local<v8::Value> val` from the `JSON::Parse` example
54
+v8::Local<v8::Object> obj = Nan::To<v8::Object>(val).ToLocalChecked();
55
+
56
+Nan::JSON NanJSON;
57
+Nan::MaybeLocal<v8::String> result = NanJSON.Stringify(obj);
58
+if (!result.IsEmpty()) {
59
+  v8::Local<v8::String> stringified = result.ToLocalChecked();
60
+}
61
+```
62
+
... ...
@@ -0,0 +1,583 @@
1
+## Maybe Types
2
+
3
+The `Nan::MaybeLocal` and `Nan::Maybe` types are monads that encapsulate `v8::Local` handles that _may be empty_.
4
+
5
+* **Maybe Types**
6
+  - <a href="#api_nan_maybe_local"><b><code>Nan::MaybeLocal</code></b></a>
7
+  - <a href="#api_nan_maybe"><b><code>Nan::Maybe</code></b></a>
8
+  - <a href="#api_nan_nothing"><b><code>Nan::Nothing</code></b></a>
9
+  - <a href="#api_nan_just"><b><code>Nan::Just</code></b></a>
10
+* **Maybe Helpers**
11
+  - <a href="#api_nan_call"><b><code>Nan::Call()</code></b></a>
12
+  - <a href="#api_nan_to_detail_string"><b><code>Nan::ToDetailString()</code></b></a>
13
+  - <a href="#api_nan_to_array_index"><b><code>Nan::ToArrayIndex()</code></b></a>
14
+  - <a href="#api_nan_equals"><b><code>Nan::Equals()</code></b></a>
15
+  - <a href="#api_nan_new_instance"><b><code>Nan::NewInstance()</code></b></a>
16
+  - <a href="#api_nan_get_function"><b><code>Nan::GetFunction()</code></b></a>
17
+  - <a href="#api_nan_set"><b><code>Nan::Set()</code></b></a>
18
+  - <a href="#api_nan_define_own_property"><b><code>Nan::DefineOwnProperty()</code></b></a>
19
+  - <a href="#api_nan_force_set"><del><b><code>Nan::ForceSet()</code></b></del></a>
20
+  - <a href="#api_nan_get"><b><code>Nan::Get()</code></b></a>
21
+  - <a href="#api_nan_get_property_attribute"><b><code>Nan::GetPropertyAttributes()</code></b></a>
22
+  - <a href="#api_nan_has"><b><code>Nan::Has()</code></b></a>
23
+  - <a href="#api_nan_delete"><b><code>Nan::Delete()</code></b></a>
24
+  - <a href="#api_nan_get_property_names"><b><code>Nan::GetPropertyNames()</code></b></a>
25
+  - <a href="#api_nan_get_own_property_names"><b><code>Nan::GetOwnPropertyNames()</code></b></a>
26
+  - <a href="#api_nan_set_prototype"><b><code>Nan::SetPrototype()</code></b></a>
27
+  - <a href="#api_nan_object_proto_to_string"><b><code>Nan::ObjectProtoToString()</code></b></a>
28
+  - <a href="#api_nan_has_own_property"><b><code>Nan::HasOwnProperty()</code></b></a>
29
+  - <a href="#api_nan_has_real_named_property"><b><code>Nan::HasRealNamedProperty()</code></b></a>
30
+  - <a href="#api_nan_has_real_indexed_property"><b><code>Nan::HasRealIndexedProperty()</code></b></a>
31
+  - <a href="#api_nan_has_real_named_callback_property"><b><code>Nan::HasRealNamedCallbackProperty()</code></b></a>
32
+  - <a href="#api_nan_get_real_named_property_in_prototype_chain"><b><code>Nan::GetRealNamedPropertyInPrototypeChain()</code></b></a>
33
+  - <a href="#api_nan_get_real_named_property"><b><code>Nan::GetRealNamedProperty()</code></b></a>
34
+  - <a href="#api_nan_call_as_function"><b><code>Nan::CallAsFunction()</code></b></a>
35
+  - <a href="#api_nan_call_as_constructor"><b><code>Nan::CallAsConstructor()</code></b></a>
36
+  - <a href="#api_nan_get_source_line"><b><code>Nan::GetSourceLine()</code></b></a>
37
+  - <a href="#api_nan_get_line_number"><b><code>Nan::GetLineNumber()</code></b></a>
38
+  - <a href="#api_nan_get_start_column"><b><code>Nan::GetStartColumn()</code></b></a>
39
+  - <a href="#api_nan_get_end_column"><b><code>Nan::GetEndColumn()</code></b></a>
40
+  - <a href="#api_nan_clone_element_at"><b><code>Nan::CloneElementAt()</code></b></a>
41
+  - <a href="#api_nan_has_private"><b><code>Nan::HasPrivate()</code></b></a>
42
+  - <a href="#api_nan_get_private"><b><code>Nan::GetPrivate()</code></b></a>
43
+  - <a href="#api_nan_set_private"><b><code>Nan::SetPrivate()</code></b></a>
44
+  - <a href="#api_nan_delete_private"><b><code>Nan::DeletePrivate()</code></b></a>
45
+  - <a href="#api_nan_make_maybe"><b><code>Nan::MakeMaybe()</code></b></a>
46
+
47
+<a name="api_nan_maybe_local"></a>
48
+### Nan::MaybeLocal
49
+
50
+A `Nan::MaybeLocal<T>` is a wrapper around [`v8::Local<T>`](https://v8docs.nodesource.com/node-8.16/de/deb/classv8_1_1_local.html) that enforces a check that determines whether the `v8::Local<T>` is empty before it can be used.
51
+
52
+If an API method returns a `Nan::MaybeLocal`, the API method can potentially fail either because an exception is thrown, or because an exception is pending, e.g. because a previous API call threw an exception that hasn't been caught yet, or because a `v8::TerminateExecution` exception was thrown. In that case, an empty `Nan::MaybeLocal` is returned.
53
+
54
+Definition:
55
+
56
+```c++
57
+template<typename T> class Nan::MaybeLocal {
58
+ public:
59
+  MaybeLocal();
60
+
61
+  template<typename S> MaybeLocal(v8::Local<S> that);
62
+
63
+  bool IsEmpty() const;
64
+
65
+  template<typename S> bool ToLocal(v8::Local<S> *out);
66
+
67
+  // Will crash if the MaybeLocal<> is empty.
68
+  v8::Local<T> ToLocalChecked();
69
+
70
+  template<typename S> v8::Local<S> FromMaybe(v8::Local<S> default_value) const;
71
+};
72
+```
73
+
74
+See the documentation for [`v8::MaybeLocal`](https://v8docs.nodesource.com/node-8.16/d8/d7d/classv8_1_1_maybe_local.html) for further details.
75
+
76
+<a name="api_nan_maybe"></a>
77
+### Nan::Maybe
78
+
79
+A simple `Nan::Maybe` type, representing an object which may or may not have a value, see https://hackage.haskell.org/package/base/docs/Data-Maybe.html.
80
+
81
+If an API method returns a `Nan::Maybe<>`, the API method can potentially fail either because an exception is thrown, or because an exception is pending, e.g. because a previous API call threw an exception that hasn't been caught yet, or because a `v8::TerminateExecution` exception was thrown. In that case, a "Nothing" value is returned.
82
+
83
+Definition:
84
+
85
+```c++
86
+template<typename T> class Nan::Maybe {
87
+ public:
88
+  bool IsNothing() const;
89
+  bool IsJust() const;
90
+
91
+  // Will crash if the Maybe<> is nothing.
92
+  T FromJust();
93
+
94
+  T FromMaybe(const T& default_value);
95
+
96
+  bool operator==(const Maybe &other);
97
+
98
+  bool operator!=(const Maybe &other);
99
+};
100
+```
101
+
102
+See the documentation for [`v8::Maybe`](https://v8docs.nodesource.com/node-8.16/d9/d4b/classv8_1_1_maybe.html) for further details.
103
+
104
+<a name="api_nan_nothing"></a>
105
+### Nan::Nothing
106
+
107
+Construct an empty `Nan::Maybe` type representing _nothing_.
108
+
109
+```c++
110
+template<typename T> Nan::Maybe<T> Nan::Nothing();
111
+```
112
+
113
+<a name="api_nan_just"></a>
114
+### Nan::Just
115
+
116
+Construct a `Nan::Maybe` type representing _just_ a value.
117
+
118
+```c++
119
+template<typename T> Nan::Maybe<T> Nan::Just(const T &t);
120
+```
121
+
122
+<a name="api_nan_call"></a>
123
+### Nan::Call()
124
+
125
+A helper method for calling a synchronous [`v8::Function#Call()`](https://v8docs.nodesource.com/node-8.16/d5/d54/classv8_1_1_function.html#a9c3d0e4e13ddd7721fce238aa5b94a11) in a way compatible across supported versions of V8.
126
+
127
+For asynchronous callbacks, use Nan::Callback::Call along with an AsyncResource.
128
+
129
+Signature:
130
+
131
+```c++
132
+Nan::MaybeLocal<v8::Value> Nan::Call(v8::Local<v8::Function> fun, v8::Local<v8::Object> recv, int argc, v8::Local<v8::Value> argv[]);
133
+Nan::MaybeLocal<v8::Value> Nan::Call(const Nan::Callback& callback, v8::Local<v8::Object> recv,
134
+ int argc, v8::Local<v8::Value> argv[]);
135
+Nan::MaybeLocal<v8::Value> Nan::Call(const Nan::Callback& callback, int argc, v8::Local<v8::Value> argv[]);
136
+```
137
+
138
+
139
+<a name="api_nan_to_detail_string"></a>
140
+### Nan::ToDetailString()
141
+
142
+A helper method for calling [`v8::Value#ToDetailString()`](https://v8docs.nodesource.com/node-8.16/dc/d0a/classv8_1_1_value.html#a2f9770296dc2c8d274bc8cc0dca243e5) in a way compatible across supported versions of V8.
143
+
144
+Signature:
145
+
146
+```c++
147
+Nan::MaybeLocal<v8::String> Nan::ToDetailString(v8::Local<v8::Value> val);
148
+```
149
+
150
+
151
+<a name="api_nan_to_array_index"></a>
152
+### Nan::ToArrayIndex()
153
+
154
+A helper method for calling [`v8::Value#ToArrayIndex()`](https://v8docs.nodesource.com/node-8.16/dc/d0a/classv8_1_1_value.html#acc5bbef3c805ec458470c0fcd6f13493) in a way compatible across supported versions of V8.
155
+
156
+Signature:
157
+
158
+```c++
159
+Nan::MaybeLocal<v8::Uint32> Nan::ToArrayIndex(v8::Local<v8::Value> val);
160
+```
161
+
162
+
163
+<a name="api_nan_equals"></a>
164
+### Nan::Equals()
165
+
166
+A helper method for calling [`v8::Value#Equals()`](https://v8docs.nodesource.com/node-8.16/dc/d0a/classv8_1_1_value.html#a08fba1d776a59bbf6864b25f9152c64b) in a way compatible across supported versions of V8.
167
+
168
+Signature:
169
+
170
+```c++
171
+Nan::Maybe<bool> Nan::Equals(v8::Local<v8::Value> a, v8::Local<v8::Value>(b));
172
+```
173
+
174
+
175
+<a name="api_nan_new_instance"></a>
176
+### Nan::NewInstance()
177
+
178
+A helper method for calling [`v8::Function#NewInstance()`](https://v8docs.nodesource.com/node-8.16/d5/d54/classv8_1_1_function.html#ae477558b10c14b76ed00e8dbab44ce5b) and [`v8::ObjectTemplate#NewInstance()`](https://v8docs.nodesource.com/node-8.16/db/d5f/classv8_1_1_object_template.html#ad605a7543cfbc5dab54cdb0883d14ae4) in a way compatible across supported versions of V8.
179
+
180
+Signature:
181
+
182
+```c++
183
+Nan::MaybeLocal<v8::Object> Nan::NewInstance(v8::Local<v8::Function> h);
184
+Nan::MaybeLocal<v8::Object> Nan::NewInstance(v8::Local<v8::Function> h, int argc, v8::Local<v8::Value> argv[]);
185
+Nan::MaybeLocal<v8::Object> Nan::NewInstance(v8::Local<v8::ObjectTemplate> h);
186
+```
187
+
188
+
189
+<a name="api_nan_get_function"></a>
190
+### Nan::GetFunction()
191
+
192
+A helper method for calling [`v8::FunctionTemplate#GetFunction()`](https://v8docs.nodesource.com/node-8.16/d8/d83/classv8_1_1_function_template.html#a56d904662a86eca78da37d9bb0ed3705) in a way compatible across supported versions of V8.
193
+
194
+Signature:
195
+
196
+```c++
197
+Nan::MaybeLocal<v8::Function> Nan::GetFunction(v8::Local<v8::FunctionTemplate> t);
198
+```
199
+
200
+
201
+<a name="api_nan_set"></a>
202
+### Nan::Set()
203
+
204
+A helper method for calling [`v8::Object#Set()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a67604ea3734f170c66026064ea808f20) in a way compatible across supported versions of V8.
205
+
206
+Signature:
207
+
208
+```c++
209
+Nan::Maybe<bool> Nan::Set(v8::Local<v8::Object> obj,
210
+                          v8::Local<v8::Value> key,
211
+                          v8::Local<v8::Value> value)
212
+Nan::Maybe<bool> Nan::Set(v8::Local<v8::Object> obj,
213
+                          uint32_t index,
214
+                          v8::Local<v8::Value> value);
215
+```
216
+
217
+
218
+<a name="api_nan_define_own_property"></a>
219
+### Nan::DefineOwnProperty()
220
+
221
+A helper method for calling [`v8::Object#DefineOwnProperty()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a6f76b2ed605cb8f9185b92de0033a820) in a way compatible across supported versions of V8.
222
+
223
+Signature:
224
+
225
+```c++
226
+Nan::Maybe<bool> Nan::DefineOwnProperty(v8::Local<v8::Object> obj,
227
+                                        v8::Local<v8::String> key,
228
+                                        v8::Local<v8::Value> value,
229
+                                        v8::PropertyAttribute attribs = v8::None);
230
+```
231
+
232
+
233
+<a name="api_nan_force_set"></a>
234
+### <del>Nan::ForceSet()</del>
235
+
236
+Deprecated, use <a href="#api_nan_define_own_property"><code>Nan::DefineOwnProperty()</code></a>.
237
+
238
+<del>A helper method for calling [`v8::Object#ForceSet()`](https://v8docs.nodesource.com/node-0.12/db/d85/classv8_1_1_object.html#acfbdfd7427b516ebdb5c47c4df5ed96c) in a way compatible across supported versions of V8.</del>
239
+
240
+Signature:
241
+
242
+```c++
243
+NAN_DEPRECATED Nan::Maybe<bool> Nan::ForceSet(v8::Local<v8::Object> obj,
244
+                                              v8::Local<v8::Value> key,
245
+                                              v8::Local<v8::Value> value,
246
+                                              v8::PropertyAttribute attribs = v8::None);
247
+```
248
+
249
+
250
+<a name="api_nan_get"></a>
251
+### Nan::Get()
252
+
253
+A helper method for calling [`v8::Object#Get()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a2565f03e736694f6b1e1cf22a0b4eac2) in a way compatible across supported versions of V8.
254
+
255
+Signature:
256
+
257
+```c++
258
+Nan::MaybeLocal<v8::Value> Nan::Get(v8::Local<v8::Object> obj,
259
+                                    v8::Local<v8::Value> key);
260
+Nan::MaybeLocal<v8::Value> Nan::Get(v8::Local<v8::Object> obj, uint32_t index);
261
+```
262
+
263
+
264
+<a name="api_nan_get_property_attribute"></a>
265
+### Nan::GetPropertyAttributes()
266
+
267
+A helper method for calling [`v8::Object#GetPropertyAttributes()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a9b898894da3d1db2714fd9325a54fe57) in a way compatible across supported versions of V8.
268
+
269
+Signature:
270
+
271
+```c++
272
+Nan::Maybe<v8::PropertyAttribute> Nan::GetPropertyAttributes(
273
+    v8::Local<v8::Object> obj,
274
+    v8::Local<v8::Value> key);
275
+```
276
+
277
+
278
+<a name="api_nan_has"></a>
279
+### Nan::Has()
280
+
281
+A helper method for calling [`v8::Object#Has()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ab3c3d89ea7c2f9afd08965bd7299a41d) in a way compatible across supported versions of V8.
282
+
283
+Signature:
284
+
285
+```c++
286
+Nan::Maybe<bool> Nan::Has(v8::Local<v8::Object> obj, v8::Local<v8::String> key);
287
+Nan::Maybe<bool> Nan::Has(v8::Local<v8::Object> obj, uint32_t index);
288
+```
289
+
290
+
291
+<a name="api_nan_delete"></a>
292
+### Nan::Delete()
293
+
294
+A helper method for calling [`v8::Object#Delete()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a48e4a19b2cedff867eecc73ddb7d377f) in a way compatible across supported versions of V8.
295
+
296
+Signature:
297
+
298
+```c++
299
+Nan::Maybe<bool> Nan::Delete(v8::Local<v8::Object> obj,
300
+                             v8::Local<v8::String> key);
301
+Nan::Maybe<bool> Nan::Delete(v8::Local<v8::Object> obj, uint32_t index);
302
+```
303
+
304
+
305
+<a name="api_nan_get_property_names"></a>
306
+### Nan::GetPropertyNames()
307
+
308
+A helper method for calling [`v8::Object#GetPropertyNames()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#aced885270cfd2c956367b5eedc7fbfe8) in a way compatible across supported versions of V8.
309
+
310
+Signature:
311
+
312
+```c++
313
+Nan::MaybeLocal<v8::Array> Nan::GetPropertyNames(v8::Local<v8::Object> obj);
314
+```
315
+
316
+
317
+<a name="api_nan_get_own_property_names"></a>
318
+### Nan::GetOwnPropertyNames()
319
+
320
+A helper method for calling [`v8::Object#GetOwnPropertyNames()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a79a6e4d66049b9aa648ed4dfdb23e6eb) in a way compatible across supported versions of V8.
321
+
322
+Signature:
323
+
324
+```c++
325
+Nan::MaybeLocal<v8::Array> Nan::GetOwnPropertyNames(v8::Local<v8::Object> obj);
326
+```
327
+
328
+
329
+<a name="api_nan_set_prototype"></a>
330
+### Nan::SetPrototype()
331
+
332
+A helper method for calling [`v8::Object#SetPrototype()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a442706b22fceda6e6d1f632122a9a9f4) in a way compatible across supported versions of V8.
333
+
334
+Signature:
335
+
336
+```c++
337
+Nan::Maybe<bool> Nan::SetPrototype(v8::Local<v8::Object> obj,
338
+                                   v8::Local<v8::Value> prototype);
339
+```
340
+
341
+
342
+<a name="api_nan_object_proto_to_string"></a>
343
+### Nan::ObjectProtoToString()
344
+
345
+A helper method for calling [`v8::Object#ObjectProtoToString()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ab7a92b4dcf822bef72f6c0ac6fea1f0b) in a way compatible across supported versions of V8.
346
+
347
+Signature:
348
+
349
+```c++
350
+Nan::MaybeLocal<v8::String> Nan::ObjectProtoToString(v8::Local<v8::Object> obj);
351
+```
352
+
353
+
354
+<a name="api_nan_has_own_property"></a>
355
+### Nan::HasOwnProperty()
356
+
357
+A helper method for calling [`v8::Object#HasOwnProperty()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ab7b7245442ca6de1e1c145ea3fd653ff) in a way compatible across supported versions of V8.
358
+
359
+Signature:
360
+
361
+```c++
362
+Nan::Maybe<bool> Nan::HasOwnProperty(v8::Local<v8::Object> obj,
363
+                                     v8::Local<v8::String> key);
364
+```
365
+
366
+
367
+<a name="api_nan_has_real_named_property"></a>
368
+### Nan::HasRealNamedProperty()
369
+
370
+A helper method for calling [`v8::Object#HasRealNamedProperty()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ad8b80a59c9eb3c1e6c3cd6c84571f767) in a way compatible across supported versions of V8.
371
+
372
+Signature:
373
+
374
+```c++
375
+Nan::Maybe<bool> Nan::HasRealNamedProperty(v8::Local<v8::Object> obj,
376
+                                           v8::Local<v8::String> key);
377
+```
378
+
379
+
380
+<a name="api_nan_has_real_indexed_property"></a>
381
+### Nan::HasRealIndexedProperty()
382
+
383
+A helper method for calling [`v8::Object#HasRealIndexedProperty()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#af94fc1135a5e74a2193fb72c3a1b9855) in a way compatible across supported versions of V8.
384
+
385
+Signature:
386
+
387
+```c++
388
+Nan::Maybe<bool> Nan::HasRealIndexedProperty(v8::Local<v8::Object> obj,
389
+                                             uint32_t index);
390
+```
391
+
392
+
393
+<a name="api_nan_has_real_named_callback_property"></a>
394
+### Nan::HasRealNamedCallbackProperty()
395
+
396
+A helper method for calling [`v8::Object#HasRealNamedCallbackProperty()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#af743b7ea132b89f84d34d164d0668811) in a way compatible across supported versions of V8.
397
+
398
+Signature:
399
+
400
+```c++
401
+Nan::Maybe<bool> Nan::HasRealNamedCallbackProperty(
402
+    v8::Local<v8::Object> obj,
403
+    v8::Local<v8::String> key);
404
+```
405
+
406
+
407
+<a name="api_nan_get_real_named_property_in_prototype_chain"></a>
408
+### Nan::GetRealNamedPropertyInPrototypeChain()
409
+
410
+A helper method for calling [`v8::Object#GetRealNamedPropertyInPrototypeChain()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a8700b1862e6b4783716964ba4d5e6172) in a way compatible across supported versions of V8.
411
+
412
+Signature:
413
+
414
+```c++
415
+Nan::MaybeLocal<v8::Value> Nan::GetRealNamedPropertyInPrototypeChain(
416
+    v8::Local<v8::Object> obj,
417
+    v8::Local<v8::String> key);
418
+```
419
+
420
+
421
+<a name="api_nan_get_real_named_property"></a>
422
+### Nan::GetRealNamedProperty()
423
+
424
+A helper method for calling [`v8::Object#GetRealNamedProperty()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a84471a824576a5994fdd0ffcbf99ccc0) in a way compatible across supported versions of V8.
425
+
426
+Signature:
427
+
428
+```c++
429
+Nan::MaybeLocal<v8::Value> Nan::GetRealNamedProperty(v8::Local<v8::Object> obj,
430
+                                                     v8::Local<v8::String> key);
431
+```
432
+
433
+
434
+<a name="api_nan_call_as_function"></a>
435
+### Nan::CallAsFunction()
436
+
437
+A helper method for calling [`v8::Object#CallAsFunction()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ad3ffc36f3dfc3592ce2a96bc047ee2cd) in a way compatible across supported versions of V8.
438
+
439
+Signature:
440
+
441
+```c++
442
+Nan::MaybeLocal<v8::Value> Nan::CallAsFunction(v8::Local<v8::Object> obj,
443
+                                               v8::Local<v8::Object> recv,
444
+                                               int argc,
445
+                                               v8::Local<v8::Value> argv[]);
446
+```
447
+
448
+
449
+<a name="api_nan_call_as_constructor"></a>
450
+### Nan::CallAsConstructor()
451
+
452
+A helper method for calling [`v8::Object#CallAsConstructor()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a50d571de50d0b0dfb28795619d07a01b) in a way compatible across supported versions of V8.
453
+
454
+Signature:
455
+
456
+```c++
457
+Nan::MaybeLocal<v8::Value> Nan::CallAsConstructor(v8::Local<v8::Object> obj,
458
+                                                  int argc,
459
+                                                  v8::Local<v8::Value> argv[]);
460
+```
461
+
462
+
463
+<a name="api_nan_get_source_line"></a>
464
+### Nan::GetSourceLine()
465
+
466
+A helper method for calling [`v8::Message#GetSourceLine()`](https://v8docs.nodesource.com/node-8.16/d9/d28/classv8_1_1_message.html#a849f7a6c41549d83d8159825efccd23a) in a way compatible across supported versions of V8.
467
+
468
+Signature:
469
+
470
+```c++
471
+Nan::MaybeLocal<v8::String> Nan::GetSourceLine(v8::Local<v8::Message> msg);
472
+```
473
+
474
+
475
+<a name="api_nan_get_line_number"></a>
476
+### Nan::GetLineNumber()
477
+
478
+A helper method for calling [`v8::Message#GetLineNumber()`](https://v8docs.nodesource.com/node-8.16/d9/d28/classv8_1_1_message.html#adbe46c10a88a6565f2732a2d2adf99b9) in a way compatible across supported versions of V8.
479
+
480
+Signature:
481
+
482
+```c++
483
+Nan::Maybe<int> Nan::GetLineNumber(v8::Local<v8::Message> msg);
484
+```
485
+
486
+
487
+<a name="api_nan_get_start_column"></a>
488
+### Nan::GetStartColumn()
489
+
490
+A helper method for calling [`v8::Message#GetStartColumn()`](https://v8docs.nodesource.com/node-8.16/d9/d28/classv8_1_1_message.html#a60ede616ba3822d712e44c7a74487ba6) in a way compatible across supported versions of V8.
491
+
492
+Signature:
493
+
494
+```c++
495
+Nan::Maybe<int> Nan::GetStartColumn(v8::Local<v8::Message> msg);
496
+```
497
+
498
+
499
+<a name="api_nan_get_end_column"></a>
500
+### Nan::GetEndColumn()
501
+
502
+A helper method for calling [`v8::Message#GetEndColumn()`](https://v8docs.nodesource.com/node-8.16/d9/d28/classv8_1_1_message.html#aaa004cf19e529da980bc19fcb76d93be) in a way compatible across supported versions of V8.
503
+
504
+Signature:
505
+
506
+```c++
507
+Nan::Maybe<int> Nan::GetEndColumn(v8::Local<v8::Message> msg);
508
+```
509
+
510
+
511
+<a name="api_nan_clone_element_at"></a>
512
+### Nan::CloneElementAt()
513
+
514
+A helper method for calling [`v8::Array#CloneElementAt()`](https://v8docs.nodesource.com/node-4.8/d3/d32/classv8_1_1_array.html#a1d3a878d4c1c7cae974dd50a1639245e) in a way compatible across supported versions of V8.
515
+
516
+Signature:
517
+
518
+```c++
519
+Nan::MaybeLocal<v8::Object> Nan::CloneElementAt(v8::Local<v8::Array> array, uint32_t index);
520
+```
521
+
522
+<a name="api_nan_has_private"></a>
523
+### Nan::HasPrivate()
524
+
525
+A helper method for calling [`v8::Object#HasPrivate()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#af68a0b98066cfdeb8f943e98a40ba08d) in a way compatible across supported versions of V8.
526
+
527
+Signature:
528
+
529
+```c++
530
+Nan::Maybe<bool> Nan::HasPrivate(v8::Local<v8::Object> object, v8::Local<v8::String> key);
531
+```
532
+
533
+<a name="api_nan_get_private"></a>
534
+### Nan::GetPrivate()
535
+
536
+A helper method for calling [`v8::Object#GetPrivate()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a169f2da506acbec34deadd9149a1925a) in a way compatible across supported versions of V8.
537
+
538
+Signature:
539
+
540
+```c++
541
+Nan::MaybeLocal<v8::Value> Nan::GetPrivate(v8::Local<v8::Object> object, v8::Local<v8::String> key);
542
+```
543
+
544
+<a name="api_nan_set_private"></a>
545
+### Nan::SetPrivate()
546
+
547
+A helper method for calling [`v8::Object#SetPrivate()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#ace1769b0f3b86bfe9fda1010916360ee) in a way compatible across supported versions of V8.
548
+
549
+Signature:
550
+
551
+```c++
552
+Nan::Maybe<bool> Nan::SetPrivate(v8::Local<v8::Object> object, v8::Local<v8::String> key, v8::Local<v8::Value> value);
553
+```
554
+
555
+<a name="api_nan_delete_private"></a>
556
+### Nan::DeletePrivate()
557
+
558
+A helper method for calling [`v8::Object#DeletePrivate()`](https://v8docs.nodesource.com/node-8.16/db/d85/classv8_1_1_object.html#a138bb32a304f3982be02ad499693b8fd) in a way compatible across supported versions of V8.
559
+
560
+Signature:
561
+
562
+```c++
563
+Nan::Maybe<bool> Nan::DeletePrivate(v8::Local<v8::Object> object, v8::Local<v8::String> key);
564
+```
565
+
566
+<a name="api_nan_make_maybe"></a>
567
+### Nan::MakeMaybe()
568
+
569
+Wraps a `v8::Local<>` in a `Nan::MaybeLocal<>`. When called with a `Nan::MaybeLocal<>` it just returns its argument. This is useful in generic template code that builds on NAN.
570
+
571
+Synopsis:
572
+
573
+```c++
574
+  MaybeLocal<v8::Number> someNumber = MakeMaybe(New<v8::Number>(3.141592654));
575
+  MaybeLocal<v8::String> someString = MakeMaybe(New<v8::String>("probably"));
576
+```
577
+
578
+Signature:
579
+
580
+```c++
581
+template <typename T, template <typename> class MaybeMaybe>
582
+Nan::MaybeLocal<T> Nan::MakeMaybe(MaybeMaybe<T> v);
583
+```
... ...
@@ -0,0 +1,664 @@
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
+
... ...
@@ -0,0 +1,147 @@
1
+## New
2
+
3
+NAN provides a `Nan::New()` helper for the creation of new JavaScript objects in a way that's compatible across the supported versions of V8.
4
+
5
+ - <a href="#api_nan_new"><b><code>Nan::New()</code></b></a>
6
+ - <a href="#api_nan_undefined"><b><code>Nan::Undefined()</code></b></a>
7
+ - <a href="#api_nan_null"><b><code>Nan::Null()</code></b></a>
8
+ - <a href="#api_nan_true"><b><code>Nan::True()</code></b></a>
9
+ - <a href="#api_nan_false"><b><code>Nan::False()</code></b></a>
10
+ - <a href="#api_nan_empty_string"><b><code>Nan::EmptyString()</code></b></a>
11
+
12
+
13
+<a name="api_nan_new"></a>
14
+### Nan::New()
15
+
16
+`Nan::New()` should be used to instantiate new JavaScript objects.
17
+
18
+Refer to the specific V8 type in the [V8 documentation](https://v8docs.nodesource.com/node-8.16/d1/d83/classv8_1_1_data.html) for information on the types of arguments required for instantiation.
19
+
20
+Signatures:
21
+
22
+Return types are mostly omitted from the signatures for simplicity. In most cases the type will be contained within a `v8::Local<T>`. The following types will be contained within a `Nan::MaybeLocal<T>`: `v8::String`, `v8::Date`, `v8::RegExp`, `v8::Script`, `v8::UnboundScript`.
23
+
24
+Empty objects:
25
+
26
+```c++
27
+Nan::New<T>();
28
+```
29
+
30
+Generic single and multiple-argument:
31
+
32
+```c++
33
+Nan::New<T>(A0 arg0);
34
+Nan::New<T>(A0 arg0, A1 arg1);
35
+Nan::New<T>(A0 arg0, A1 arg1, A2 arg2);
36
+Nan::New<T>(A0 arg0, A1 arg1, A2 arg2, A3 arg3);
37
+```
38
+
39
+For creating `v8::FunctionTemplate` and `v8::Function` objects:
40
+
41
+_The definition of `Nan::FunctionCallback` can be found in the [Method declaration](./methods.md#api_nan_method) documentation._
42
+
43
+```c++
44
+Nan::New<T>(Nan::FunctionCallback callback,
45
+            v8::Local<v8::Value> data = v8::Local<v8::Value>());
46
+Nan::New<T>(Nan::FunctionCallback callback,
47
+            v8::Local<v8::Value> data = v8::Local<v8::Value>(),
48
+            A2 a2 = A2());
49
+```
50
+
51
+Native number types:
52
+
53
+```c++
54
+v8::Local<v8::Boolean> Nan::New<T>(bool value);
55
+v8::Local<v8::Int32> Nan::New<T>(int32_t value);
56
+v8::Local<v8::Uint32> Nan::New<T>(uint32_t value);
57
+v8::Local<v8::Number> Nan::New<T>(double value);
58
+```
59
+
60
+String types:
61
+
62
+```c++
63
+Nan::MaybeLocal<v8::String> Nan::New<T>(std::string const& value);
64
+Nan::MaybeLocal<v8::String> Nan::New<T>(const char * value, int length);
65
+Nan::MaybeLocal<v8::String> Nan::New<T>(const char * value);
66
+Nan::MaybeLocal<v8::String> Nan::New<T>(const uint16_t * value);
67
+Nan::MaybeLocal<v8::String> Nan::New<T>(const uint16_t * value, int length);
68
+```
69
+
70
+Specialized types:
71
+
72
+```c++
73
+v8::Local<v8::String> Nan::New<T>(v8::String::ExternalStringResource * value);
74
+v8::Local<v8::String> Nan::New<T>(Nan::ExternalOneByteStringResource * value);
75
+v8::Local<v8::RegExp> Nan::New<T>(v8::Local<v8::String> pattern, v8::RegExp::Flags flags);
76
+```
77
+
78
+Note that `Nan::ExternalOneByteStringResource` maps to [`v8::String::ExternalOneByteStringResource`](https://v8docs.nodesource.com/node-8.16/d9/db3/classv8_1_1_string_1_1_external_one_byte_string_resource.html), and `v8::String::ExternalAsciiStringResource` in older versions of V8.
79
+
80
+
81
+<a name="api_nan_undefined"></a>
82
+### Nan::Undefined()
83
+
84
+A helper method to reference the `v8::Undefined` object in a way that is compatible across all supported versions of V8.
85
+
86
+Signature:
87
+
88
+```c++
89
+v8::Local<v8::Primitive> Nan::Undefined()
90
+```
91
+
92
+<a name="api_nan_null"></a>
93
+### Nan::Null()
94
+
95
+A helper method to reference the `v8::Null` object in a way that is compatible across all supported versions of V8.
96
+
97
+Signature:
98
+
99
+```c++
100
+v8::Local<v8::Primitive> Nan::Null()
101
+```
102
+
103
+<a name="api_nan_true"></a>
104
+### Nan::True()
105
+
106
+A helper method to reference the `v8::Boolean` object representing the `true` value in a way that is compatible across all supported versions of V8.
107
+
108
+Signature:
109
+
110
+```c++
111
+v8::Local<v8::Boolean> Nan::True()
112
+```
113
+
114
+<a name="api_nan_false"></a>
115
+### Nan::False()
116
+
117
+A helper method to reference the `v8::Boolean` object representing the `false` value in a way that is compatible across all supported versions of V8.
118
+
119
+Signature:
120
+
121
+```c++
122
+v8::Local<v8::Boolean> Nan::False()
123
+```
124
+
125
+<a name="api_nan_empty_string"></a>
126
+### Nan::EmptyString()
127
+
128
+Call [`v8::String::Empty`](https://v8docs.nodesource.com/node-8.16/d2/db3/classv8_1_1_string.html#a7c1bc8886115d7ee46f1d571dd6ebc6d) to reference the empty string in a way that is compatible across all supported versions of V8.
129
+
130
+Signature:
131
+
132
+```c++
133
+v8::Local<v8::String> Nan::EmptyString()
134
+```
135
+
136
+
137
+<a name="api_nan_new_one_byte_string"></a>
138
+### Nan::NewOneByteString()
139
+
140
+An implementation of [`v8::String::NewFromOneByte()`](https://v8docs.nodesource.com/node-8.16/d2/db3/classv8_1_1_string.html#a5264d50b96d2c896ce525a734dc10f09) provided for consistent availability and API across supported versions of V8. Allocates a new string from Latin-1 data.
141
+
142
+Signature:
143
+
144
+```c++
145
+Nan::MaybeLocal<v8::String> Nan::NewOneByteString(const uint8_t * value,
146
+                                                  int length = -1)
147
+```
... ...
@@ -0,0 +1,123 @@
1
+## Miscellaneous Node Helpers
2
+
3
+ - <a href="#api_nan_asyncresource"><b><code>Nan::AsyncResource</code></b></a>
4
+ - <a href="#api_nan_make_callback"><b><code>Nan::MakeCallback()</code></b></a>
5
+ - <a href="#api_nan_module_init"><b><code>NAN_MODULE_INIT()</code></b></a>
6
+ - <a href="#api_nan_export"><b><code>Nan::Export()</code></b></a>
7
+
8
+<a name="api_nan_asyncresource"></a>
9
+### Nan::AsyncResource
10
+
11
+This class is analogous to the `AsyncResource` JavaScript class exposed by Node's [async_hooks][] API.
12
+
13
+When calling back into JavaScript asynchronously, special care must be taken to ensure that the runtime can properly track
14
+async hops. `Nan::AsyncResource` is a class that provides an RAII wrapper around `node::EmitAsyncInit`, `node::EmitAsyncDestroy`,
15
+and `node::MakeCallback`. Using this mechanism to call back into JavaScript, as opposed to `Nan::MakeCallback` or
16
+`v8::Function::Call` ensures that the callback is executed in the correct async context. This ensures that async mechanisms
17
+such as domains and [async_hooks][] function correctly.
18
+
19
+Definition:
20
+
21
+```c++
22
+class AsyncResource {
23
+ public:
24
+  AsyncResource(v8::Local<v8::String> name,
25
+                v8::Local<v8::Object> resource = New<v8::Object>());
26
+  AsyncResource(const char* name,
27
+                v8::Local<v8::Object> resource = New<v8::Object>());
28
+  ~AsyncResource();
29
+
30
+  v8::MaybeLocal<v8::Value> runInAsyncScope(v8::Local<v8::Object> target,
31
+                                            v8::Local<v8::Function> func,
32
+                                            int argc,
33
+                                            v8::Local<v8::Value>* argv);
34
+  v8::MaybeLocal<v8::Value> runInAsyncScope(v8::Local<v8::Object> target,
35
+                                            v8::Local<v8::String> symbol,
36
+                                            int argc,
37
+                                            v8::Local<v8::Value>* argv);
38
+  v8::MaybeLocal<v8::Value> runInAsyncScope(v8::Local<v8::Object> target,
39
+                                            const char* method,
40
+                                            int argc,
41
+                                            v8::Local<v8::Value>* argv);
42
+};
43
+```
44
+
45
+* `name`: Identifier for the kind of resource that is being provided for diagnostics information exposed by the [async_hooks][]
46
+  API. This will be passed to the possible `init` hook as the `type`. To avoid name collisions with other modules we recommend
47
+  that the name include the name of the owning module as a prefix. For example `mysql` module could use something like
48
+  `mysql:batch-db-query-resource`.
49
+* `resource`: An optional object associated with the async work that will be passed to the possible [async_hooks][]
50
+  `init` hook. If this parameter is omitted, or an empty handle is provided, this object will be created automatically.
51
+* When calling JS on behalf of this resource, one can use `runInAsyncScope`. This will ensure that the callback runs in the
52
+  correct async execution context.
53
+* `AsyncDestroy` is automatically called when an AsyncResource object is destroyed.
54
+
55
+For more details, see the Node [async_hooks][] documentation. You might also want to take a look at the documentation for the
56
+[N-API counterpart][napi]. For example usage, see the `asyncresource.cpp` example in the `test/cpp` directory.
57
+
58
+<a name="api_nan_make_callback"></a>
59
+### Nan::MakeCallback()
60
+
61
+Deprecated wrappers around the legacy `node::MakeCallback()` APIs. Node.js 10+
62
+has deprecated these legacy APIs as they do not provide a mechanism to preserve
63
+async context.
64
+
65
+We recommend that you use the `AsyncResource` class and `AsyncResource::runInAsyncScope` instead of using `Nan::MakeCallback` or
66
+`v8::Function#Call()` directly. `AsyncResource` properly takes care of running the callback in the correct async execution
67
+context – something that is essential for functionality like domains, async_hooks and async debugging.
68
+
69
+Signatures:
70
+
71
+```c++
72
+NAN_DEPRECATED
73
+v8::Local<v8::Value> Nan::MakeCallback(v8::Local<v8::Object> target,
74
+                                       v8::Local<v8::Function> func,
75
+                                       int argc,
76
+                                       v8::Local<v8::Value>* argv);
77
+NAN_DEPRECATED
78
+v8::Local<v8::Value> Nan::MakeCallback(v8::Local<v8::Object> target,
79
+                                       v8::Local<v8::String> symbol,
80
+                                       int argc,
81
+                                       v8::Local<v8::Value>* argv);
82
+NAN_DEPRECATED
83
+v8::Local<v8::Value> Nan::MakeCallback(v8::Local<v8::Object> target,
84
+                                       const char* method,
85
+                                       int argc,
86
+                                       v8::Local<v8::Value>* argv);
87
+```
88
+
89
+
90
+<a name="api_nan_module_init"></a>
91
+### NAN_MODULE_INIT()
92
+
93
+Used to define the entry point function to a Node add-on. Creates a function with a given `name` that receives a `target` object representing the equivalent of the JavaScript `exports` object.
94
+
95
+See example below.
96
+
97
+<a name="api_nan_export"></a>
98
+### Nan::Export()
99
+
100
+A simple helper to register a `v8::FunctionTemplate` from a JavaScript-accessible method (see [Methods](./methods.md)) as a property on an object. Can be used in a way similar to assigning properties to `module.exports` in JavaScript.
101
+
102
+Signature:
103
+
104
+```c++
105
+void Export(v8::Local<v8::Object> target, const char *name, Nan::FunctionCallback f)
106
+```
107
+
108
+Also available as the shortcut `NAN_EXPORT` macro.
109
+
110
+Example:
111
+
112
+```c++
113
+NAN_METHOD(Foo) {
114
+  ...
115
+}
116
+
117
+NAN_MODULE_INIT(Init) {
118
+  NAN_EXPORT(target, Foo);
119
+}
120
+```
121
+
122
+[async_hooks]: https://nodejs.org/dist/latest-v9.x/docs/api/async_hooks.html
123
+[napi]: https://nodejs.org/dist/latest-v9.x/docs/api/n-api.html#n_api_custom_asynchronous_operations
... ...
@@ -0,0 +1,263 @@
1
+## Object Wrappers
2
+
3
+The `ObjectWrap` class can be used to make wrapped C++ objects and a factory of wrapped objects.
4
+
5
+ - <a href="#api_nan_object_wrap"><b><code>Nan::ObjectWrap</code></b></a>
6
+
7
+
8
+<a name="api_nan_object_wrap"></a>
9
+### Nan::ObjectWrap()
10
+
11
+A reimplementation of `node::ObjectWrap` that adds some API not present in older versions of Node. Should be preferred over `node::ObjectWrap` in all cases for consistency.
12
+
13
+Definition:
14
+
15
+```c++
16
+class ObjectWrap {
17
+ public:
18
+  ObjectWrap();
19
+
20
+  virtual ~ObjectWrap();
21
+
22
+  template <class T>
23
+  static inline T* Unwrap(v8::Local<v8::Object> handle);
24
+
25
+  inline v8::Local<v8::Object> handle();
26
+
27
+  inline Nan::Persistent<v8::Object>& persistent();
28
+
29
+ protected:
30
+  inline void Wrap(v8::Local<v8::Object> handle);
31
+
32
+  inline void MakeWeak();
33
+
34
+  /* Ref() marks the object as being attached to an event loop.
35
+   * Refed objects will not be garbage collected, even if
36
+   * all references are lost.
37
+   */
38
+  virtual void Ref();
39
+
40
+  /* Unref() marks an object as detached from the event loop.  This is its
41
+   * default state.  When an object with a "weak" reference changes from
42
+   * attached to detached state it will be freed. Be careful not to access
43
+   * the object after making this call as it might be gone!
44
+   * (A "weak reference" means an object that only has a
45
+   * persistent handle.)
46
+   *
47
+   * DO NOT CALL THIS FROM DESTRUCTOR
48
+   */
49
+  virtual void Unref();
50
+
51
+  int refs_;  // ro
52
+};
53
+```
54
+
55
+See the Node documentation on [Wrapping C++ Objects](https://nodejs.org/api/addons.html#addons_wrapping_c_objects) for more details.
56
+
57
+### This vs. Holder
58
+
59
+When calling `Unwrap`, it is important that the argument is indeed some JavaScript object which got wrapped by a `Wrap` call for this class or any derived class.
60
+The `Signature` installed by [`Nan::SetPrototypeMethod()`](methods.md#api_nan_set_prototype_method) does ensure that `info.Holder()` is just such an instance.
61
+In Node 0.12 and later, `info.This()` will also be of such a type, since otherwise the invocation will get rejected.
62
+However, in Node 0.10 and before it was possible to invoke a method on a JavaScript object which just had the extension type in its prototype chain.
63
+In such a situation, calling `Unwrap` on `info.This()` will likely lead to a failed assertion causing a crash, but could lead to even more serious corruption.
64
+
65
+On the other hand, calling `Unwrap` in an [accessor](methods.md#api_nan_set_accessor) should not use `Holder()` if the accessor is defined on the prototype.
66
+So either define your accessors on the instance template,
67
+or use `This()` after verifying that it is indeed a valid object.
68
+
69
+### Examples
70
+
71
+#### Basic
72
+
73
+```c++
74
+class MyObject : public Nan::ObjectWrap {
75
+ public:
76
+  static NAN_MODULE_INIT(Init) {
77
+    v8::Local<v8::FunctionTemplate> tpl = Nan::New<v8::FunctionTemplate>(New);
78
+    tpl->SetClassName(Nan::New("MyObject").ToLocalChecked());
79
+    tpl->InstanceTemplate()->SetInternalFieldCount(1);
80
+
81
+    Nan::SetPrototypeMethod(tpl, "getHandle", GetHandle);
82
+    Nan::SetPrototypeMethod(tpl, "getValue", GetValue);
83
+
84
+    constructor().Reset(Nan::GetFunction(tpl).ToLocalChecked());
85
+    Nan::Set(target, Nan::New("MyObject").ToLocalChecked(),
86
+      Nan::GetFunction(tpl).ToLocalChecked());
87
+  }
88
+
89
+ private:
90
+  explicit MyObject(double value = 0) : value_(value) {}
91
+  ~MyObject() {}
92
+
93
+  static NAN_METHOD(New) {
94
+    if (info.IsConstructCall()) {
95
+      double value = info[0]->IsUndefined() ? 0 : Nan::To<double>(info[0]).FromJust();
96
+      MyObject *obj = new MyObject(value);
97
+      obj->Wrap(info.This());
98
+      info.GetReturnValue().Set(info.This());
99
+    } else {
100
+      const int argc = 1;
101
+      v8::Local<v8::Value> argv[argc] = {info[0]};
102
+      v8::Local<v8::Function> cons = Nan::New(constructor());
103
+      info.GetReturnValue().Set(Nan::NewInstance(cons, argc, argv).ToLocalChecked());
104
+    }
105
+  }
106
+
107
+  static NAN_METHOD(GetHandle) {
108
+    MyObject* obj = Nan::ObjectWrap::Unwrap<MyObject>(info.Holder());
109
+    info.GetReturnValue().Set(obj->handle());
110
+  }
111
+
112
+  static NAN_METHOD(GetValue) {
113
+    MyObject* obj = Nan::ObjectWrap::Unwrap<MyObject>(info.Holder());
114
+    info.GetReturnValue().Set(obj->value_);
115
+  }
116
+
117
+  static inline Nan::Persistent<v8::Function> & constructor() {
118
+    static Nan::Persistent<v8::Function> my_constructor;
119
+    return my_constructor;
120
+  }
121
+
122
+  double value_;
123
+};
124
+
125
+NODE_MODULE(objectwrapper, MyObject::Init)
126
+```
127
+
128
+To use in Javascript:
129
+
130
+```Javascript
131
+var objectwrapper = require('bindings')('objectwrapper');
132
+
133
+var obj = new objectwrapper.MyObject(5);
134
+console.log('Should be 5: ' + obj.getValue());
135
+```
136
+
137
+#### Factory of wrapped objects
138
+
139
+```c++
140
+class MyFactoryObject : public Nan::ObjectWrap {
141
+ public:
142
+  static NAN_MODULE_INIT(Init) {
143
+    v8::Local<v8::FunctionTemplate> tpl = Nan::New<v8::FunctionTemplate>(New);
144
+    tpl->InstanceTemplate()->SetInternalFieldCount(1);
145
+
146
+    Nan::SetPrototypeMethod(tpl, "getValue", GetValue);
147
+
148
+    constructor().Reset(Nan::GetFunction(tpl).ToLocalChecked());
149
+  }
150
+
151
+  static NAN_METHOD(NewInstance) {
152
+    v8::Local<v8::Function> cons = Nan::New(constructor());
153
+    double value = info[0]->IsNumber() ? Nan::To<double>(info[0]).FromJust() : 0;
154
+    const int argc = 1;
155
+    v8::Local<v8::Value> argv[1] = {Nan::New(value)};
156
+    info.GetReturnValue().Set(Nan::NewInstance(cons, argc, argv).ToLocalChecked());
157
+  }
158
+
159
+  // Needed for the next example:
160
+  inline double value() const {
161
+    return value_;
162
+  }
163
+
164
+ private:
165
+  explicit MyFactoryObject(double value = 0) : value_(value) {}
166
+  ~MyFactoryObject() {}
167
+
168
+  static NAN_METHOD(New) {
169
+    if (info.IsConstructCall()) {
170
+      double value = info[0]->IsNumber() ? Nan::To<double>(info[0]).FromJust() : 0;
171
+      MyFactoryObject * obj = new MyFactoryObject(value);
172
+      obj->Wrap(info.This());
173
+      info.GetReturnValue().Set(info.This());
174
+    } else {
175
+      const int argc = 1;
176
+      v8::Local<v8::Value> argv[argc] = {info[0]};
177
+      v8::Local<v8::Function> cons = Nan::New(constructor());
178
+      info.GetReturnValue().Set(Nan::NewInstance(cons, argc, argv).ToLocalChecked());
179
+    }
180
+  }
181
+
182
+  static NAN_METHOD(GetValue) {
183
+    MyFactoryObject* obj = ObjectWrap::Unwrap<MyFactoryObject>(info.Holder());
184
+    info.GetReturnValue().Set(obj->value_);
185
+  }
186
+
187
+  static inline Nan::Persistent<v8::Function> & constructor() {
188
+    static Nan::Persistent<v8::Function> my_constructor;
189
+    return my_constructor;
190
+  }
191
+
192
+  double value_;
193
+};
194
+
195
+NAN_MODULE_INIT(Init) {
196
+  MyFactoryObject::Init(target);
197
+  Nan::Set(target,
198
+    Nan::New<v8::String>("newFactoryObjectInstance").ToLocalChecked(),
199
+    Nan::GetFunction(
200
+      Nan::New<v8::FunctionTemplate>(MyFactoryObject::NewInstance)).ToLocalChecked()
201
+  );
202
+}
203
+
204
+NODE_MODULE(wrappedobjectfactory, Init)
205
+```
206
+
207
+To use in Javascript:
208
+
209
+```Javascript
210
+var wrappedobjectfactory = require('bindings')('wrappedobjectfactory');
211
+
212
+var obj = wrappedobjectfactory.newFactoryObjectInstance(10);
213
+console.log('Should be 10: ' + obj.getValue());
214
+```
215
+
216
+#### Passing wrapped objects around
217
+
218
+Use the `MyFactoryObject` class above along with the following:
219
+
220
+```c++
221
+static NAN_METHOD(Sum) {
222
+  Nan::MaybeLocal<v8::Object> maybe1 = Nan::To<v8::Object>(info[0]);
223
+  Nan::MaybeLocal<v8::Object> maybe2 = Nan::To<v8::Object>(info[1]);
224
+
225
+  // Quick check:
226
+  if (maybe1.IsEmpty() || maybe2.IsEmpty()) {
227
+    // return value is undefined by default
228
+    return;
229
+  }
230
+
231
+  MyFactoryObject* obj1 =
232
+    Nan::ObjectWrap::Unwrap<MyFactoryObject>(maybe1.ToLocalChecked());
233
+  MyFactoryObject* obj2 =
234
+    Nan::ObjectWrap::Unwrap<MyFactoryObject>(maybe2.ToLocalChecked());
235
+
236
+  info.GetReturnValue().Set(Nan::New<v8::Number>(obj1->value() + obj2->value()));
237
+}
238
+
239
+NAN_MODULE_INIT(Init) {
240
+  MyFactoryObject::Init(target);
241
+  Nan::Set(target,
242
+    Nan::New<v8::String>("newFactoryObjectInstance").ToLocalChecked(),
243
+    Nan::GetFunction(
244
+      Nan::New<v8::FunctionTemplate>(MyFactoryObject::NewInstance)).ToLocalChecked()
245
+  );
246
+  Nan::Set(target,
247
+    Nan::New<v8::String>("sum").ToLocalChecked(),
248
+    Nan::GetFunction(Nan::New<v8::FunctionTemplate>(Sum)).ToLocalChecked()
249
+  );
250
+}
251
+
252
+NODE_MODULE(myaddon, Init)
253
+```
254
+
255
+To use in Javascript:
256
+
257
+```Javascript
258
+var myaddon = require('bindings')('myaddon');
259
+
260
+var obj1 = myaddon.newFactoryObjectInstance(5);
261
+var obj2 = myaddon.newFactoryObjectInstance(10);
262
+console.log('sum of object values: ' + myaddon.sum(obj1, obj2));
263
+```
... ...
@@ -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
+