Have ideas to improve npm?Join in the discussion! »

This package has been deprecated

Author message:

use @broid/irc instead

broid-irc

1.0.0 • Public • Published

npm node deps tests bithound bithoundscore nsp-checked

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.

gitter

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

Connect to Twitter

import broidIRC from '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 availables

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 message_formated = '...'
 
irc.send(message_formated)
  .then(() => console.log("ok"))
  .catch(err => console.error(err))

Examples of messages

Message received

  • A direct message received from Sally
{
  "@context": "https://www.w3.org/ns/activitystreams",
  "published": 1483589416,
  "type": "Create",
  "generator": {
    "id": "73301570-7ec7-45ce-b035-2ff4831306ab",
    "type": "Service",
    "name": "irc"
  },
  "actor": {
    "id": "SallyDude",
    "type": "Person",
    "name": "SallyDude"
  },
  "target": {
    "id": "#supersecretirc",
    "type": "Group",
    "name": "#supersecretirc"
  },
  "object": {
    "type": "Note",
    "id": "73301570-7ec7-45ce-b035-2ff4831306ab",
    "content": "hello world"
  }
}
  • A message received from Sally through a private message.
{
  "@context": "https://www.w3.org/ns/activitystreams",
  "published": 1483590793,
  "type": "Create",
  "generator": {
    "id": "55c5e6a2-a1a3-4fc6-b94a-7011d9faa0a2",
    "type": "Service",
    "name": "irc"
  },
  "actor": {
    "id": "SallyDude",
    "type": "Person",
    "name": "SallyDude"
  },
  "target": {
    "id": "248881752",
    "type": "Group",
    "name": "JohnDow"
  },
  "object": {
    "type": "Note",
    "id": "55c5e6a2-a1a3-4fc6-b94a-7011d9faa0a2",
    "content": "hello world"
  }
}

Send a message

  • Send a simple message to the channel
{
  "@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"
  }
}

Contributing to Broid

Broid is an open source project. Broid wouldn't be where it is now without contributions by the community. Please consider forking Broid to improve, enhance or fix issues. If you feel like the community will benefit from your fork, please open a pull request.

And because we want to do the better for you. Help us improving Broid by sharing your feedback on our Integrations GitHub Repo and let's build Broid together!

Code of Conduct

Make sure that you're read and understand the Code of Conduct.

Copyright & License

Copyright (c) 2016-2017 Broid.ai

This project is licensed under the AGPL 3, which can be found here.

Keywords

none

Install

npm i broid-irc

DownloadsWeekly Downloads

2

Version

1.0.0

License

AGPL-3.0+

Last publish

Collaborators

  • avatar