@sockethub/platform-irc

4.0.0-alpha.3 • Public • Published

sockethub-platform-irc

A sockethub platform module implementing IRC functionality.

About

This module contains all of the implementation details of an IRC client and is used as a sockethub platform.

Implemented (@type)

completed send completed join completed leave completed observe completed update

Example

Each sockethub platform uses JSON Activity Streams 2.0 which are received from and sent to clients, through the Sockethub service.

Incoming

Connected to IRC

{
  "@type": "announce",
  "context": "irc",
  "actor": {
    "@id": "irc.freenode.net",
    "@type": "service"
  },
  "published": "2015-05-20T22:32:06.212Z",
  "target": {
    "@id": "foobar@irc.freenode.net",
    "@type": "person",
    "displayName": "Foobar McUser"
  },
  "object": {
    "@type": "content",
    "content": {
      "network":{
         "name":"freenode",
         "hostname":"orwell.freenode.net",
         "ircd":"ircd-seven-1.1.3",
         "nicklength":16,
         "maxtargets":{
            "NAMES":1,
            "LIST":1,
            "KICK":1,
            "WHOIS":1,
            "PRIVMSG":4,
            "NOTICE":4,
            "ACCEPT":0,
            "MONITOR":0
         }
      },
      "channel":{
         "idlength":{

         },
         "limit":{
            "#":120
         },
         "length":50,
         "modes":4,
         "types":"#",
         "kicklength":0,
         "topiclength":390
      },
      "modes":{
         "user":"DOQRSZaghilopswz",
         "channel":"CFILMPQSbcefgijklmnopqrstvz",
         "param":"bkloveqjfI",
         "types":{
            "a":"eIbq",
            "b":"kov",
            "c":"flj",
            "d":"CFLMPQScgimnprstz"
         },
         "prefixes":"@+",
         "prefixmodes":{
            "o":"@",
            "v":"+"
         },
         "maxlist":{
            "bqeI":100
         }
      }
    }
  }
}

API

API docs can be found here

Package Sidebar

Install

npm i @sockethub/platform-irc

Weekly Downloads

0

Version

4.0.0-alpha.3

License

LGPL-3.0+

Unpacked Size

44.4 kB

Total Files

7

Last publish

Collaborators

  • skddc
  • galfert
  • silverbucket