@broid/irc
v2.2.0
Published
Convert IRC messages into Activity Streams 2 with Broid Integration
Downloads
7
Readme
Broid IRC Integration
Broid Integrations is an open source project providing a suite of Activity Streams 2 libraries for unified communications among a vast number of communication platforms.
Connect your App to Multiple Messaging Channels with One OpenSource Language.
Message types supported
| Simple | Image | Video | Buttons | Location | Phone number | |:------:|:-----:|:-----:|:-------:|:--------:|:------------:| | ✅ | ✅ | ✅ | | | |
Buttons, Location, Phone number are platform limitations.
Image, Video are supported as a simple message
Getting started
Install
npm install --save @broid/irc
Connect to Twitter
const BroidIRC = require('@broid/irc');
const irc = new broidIRC({
address: 'irc.freenode.net'
username: 'JohnDow',
channels: ['#supersecretirc']
});
irc.connect()
.subscribe({
next: data => console.log(data),
error: err => console.error(`Something went wrong: ${err.message}`),
complete: () => console.log('complete'),
});
Options available
| name | Type | default | Description |
| ----------------- |:--------:| :--------: | --------------------------|
| serviceID | string | random | Arbitrary identifier of the running instance |
| logLevel | string | info
| Can be : fatal
, error
, warn
, info
, debug
, trace
|
| connectionTimeout | number | 60s | Connection timeout when connectiong to server |
Receive a message
irc.listen()
.subscribe({
next: data => console.log(`Received message: ${data}`),
error: err => console.error(`Something went wrong: ${err.message}`),
complete: () => console.log('complete'),
});
Post a message
To send a message, the format should use the broid-schemas.
const formatted_message = {
"@context": "https://www.w3.org/ns/activitystreams",
"type": "Create",
"generator": {
"id": "f6e92eb6-f69e-4eae-8158-06613461cf3a",
"type": "Service",
"name": "irc"
},
"object": {
"type": "Note",
"content": "hello world"
},
"to": {
"type": "Group",
"id": "#supersecretirc"
}
};
irc.send(formatted_message)
.then(() => console.log("ok"))
.catch(err => console.error(err));
Examples of messages
You can find examples of sent and received messages at Broid-Schemas.
Contributing to Broid
See CONTRIBUTE.md
Copyright & License
Copyright (c) 2016-2017 Broid.ai
This project is licensed under the AGPL 3, which can be found here.