https://github.com/ppvg/node-ircc
IRC connection library for Node.js.
https://github.com/ppvg/node-ircc
Last synced: 2 months ago
JSON representation
IRC connection library for Node.js.
- Host: GitHub
- URL: https://github.com/ppvg/node-ircc
- Owner: ppvg
- License: bsd-2-clause
- Created: 2013-07-13T08:33:05.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-07-22T09:13:37.000Z (almost 12 years ago)
- Last Synced: 2025-02-27T15:39:19.873Z (3 months ago)
- Language: LiveScript
- Homepage: https://npmjs.org/package/ircc
- Size: 207 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ircc
[](https://drone.io/github.com/PPvG/node-ircc/latest) [](https://drone.io/github.com/PPvG/node-ircc/files/coverage.html)
IRC connection library for Node.js.
Sets up a connection to an IRC server and then gets out of the way. It doesn't respond to `PING`s, doesn't send `NICK` and `USER` at the start of the session, et cetera.
#### Installation
`$ npm install ircc`
#### Dependencies
- Node.js 0.9.8 or above.
- [ircp]
[ircp]: https://npmjs.org/package/ircp
## Example
var ircc = require('ircc');
var connection = ircc.createConnection(6667, 'irc.example.com');
connection.on('message', function(message) {
if (message.command === 'PRIVMSG')
console.log message.parameters[0]+":", message.parameters[1]
connection.send('PRIVMSGM', message.parameters[0], "HELLO!");
});
connection.on('connect', function() {
connection.send('NICK', 'PrawnBoy');
connection.send('USER', 'prawnboy', 0, 0, 'Insanity Prawn Boy');
});
## API
### ircc.createConnection(port, host, [connectListener])
Create a new `Connection` object and connect it to the IRC server at `host:port`. The `connectListener` is optional and will be attached as a listener to the `connect` event.
### ircc.Connection
var connection = new ircc.Connection();
#### connection.connect(...)
Connect to an IRC server. Takes the same arguments as [`socket.connect(...)`][1]. Throws an error if the connection is already up.
[1]: http://nodejs.org/api/net.html#net_socket_connect_port_host_connectlistener
#### connection.close()
Close the connection. Throws an error if it was already closed.
#### connection.send(messageObject)
#### connection.send(command, [parameters...])
Send a message to the IRC server. The first argument is mandatory and can either be a message object or a string.
If the first argument is an object, no further arguments are expected. If it's a string, it's treated as the command and any further arguments are interpreted as the message parameters.
For example:
connection.send({command: 'KICK', parameters: ['#channel', 'marvin']});
connection.send('PRIVMSG', '#channel', 'Hi there, folks!');
#### connection.on('message', function(message) {})
Emitted when a message is received from the server. The `message` is an object, such as:
{ command: 'PART',
parameters: [ '#channel' ],
nick: 'nick',
user: 'user',
host: 'host',
type: 'command' }
...or:
{ command: 'WELCOME',
parameters:
[ 'botname',
'Welcome to the example IRC network!' ],
server: 'irc.example.com',
code: '001',
type: 'reply' }
The `type` is either 'command', 'reply', 'error' or 'unknown'. If the message was a numeric response, `code` will be the original command, and `command` will be a human-readable substitute. For more details, see [ircp][ircp].
#### connection.on('connect', function() {})
Emitted once the connection is succesfully set up.
#### connection.on('close', function() {})
Emitted after the connection is closed.
### ircc.ParserStream and ircc.SerializerStream
var serializer = new ircc.SerializerStream();
var parser = new ircc.ParserStream();
These are used internally by `Connection`. They're [Transform streams][2] that form a stream-based interface to [ircp][ircp]'s `parse` and `serialize` functions. The most common use case is to `.pipe()` them to a `Socket` connection to an IRC server:
[2]: http://nodejs.org/api/stream.html#stream_class_stream_transform
var socket = net.createConnection(/*...*/);
serializer.pipe(socket).pipe(parser);
// The parser emits ircp message objects:
parser.on('readable', function() {
var message;
while (var message = parser.read()) {
console.log(message); // { command: 'WELCOME', parameters: [...etc.
}
});
// You can .write() outgoing message objects to the serializer:
var message = {
command: 'PRIVMSG',
parameters: [
'#channel',
'Hi there, folks!'
]
};
serializer.write(message);
Note that the SerializerStream doesn't take strings, just message objects.
## License
Copyright (c) 2013, Peter-Paul van Gemerden <[email protected]>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.