NodeJS IRC client library
  • TypeScript 94.1%
  • JavaScript 4.5%
  • Shell 1.4%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Andrew Ferrazzutti c5f67fcd56
Merge pull request #120 from matrix-org/af/npm-trusted-publishing
Support NPM Trusted Publishing
2026-04-08 08:36:51 -04:00
.github Support NPM Trusted Publishing 2026-04-02 11:29:19 -04:00
changelog.d Support NPM Trusted Publishing 2026-04-02 11:29:19 -04:00
docs Add new option encodingFallback to guess non-utf-8 encoding correctly. 2020-04-27 21:15:52 +03:00
example Add SASL EXTERNAL authentication and example 2020-06-04 18:34:05 +02:00
scripts 2.0.0 2023-04-26 09:52:57 +01:00
spec Fix tests 2023-07-27 17:29:25 +01:00
src Make sure we don't lose PART reasons 2025-02-25 10:50:55 +01:00
test Add a test for PART reasons 2025-02-25 10:52:00 +01:00
.eslintrc Type fixes 2021-05-18 17:19:58 +01:00
.gitignore Typescript bits 2021-05-17 19:18:52 +01:00
.node-version Update .node-version 2024-03-20 15:02:26 +01:00
.npmignore https://github.com/yarnpkg/yarn/issues/5235#issuecomment-571206092 2021-05-18 13:56:14 +01:00
CHANGELOG.md 3.0.0 2024-03-27 10:10:40 +00:00
CONTRIBUTING.md Replace contributing with our regular one 2022-09-07 16:36:23 +01:00
COPYING Revert "remove old files for a clean slate" 2014-05-30 00:07:22 +01:00
jest.config.js Triple the test timeout 2023-05-02 15:57:35 +01:00
package.json 3.0.0 2024-03-27 10:10:40 +00:00
pyproject.toml Ignore .gitkeep files in towncrier checks 2024-08-01 15:45:52 +02:00
README.md Drop npm, use yarn 2022-10-03 14:40:20 +01:00
tsconfig.json Replace tape/tap with Jest 2023-05-15 14:13:10 +01:00
yarn.lock Update our dependencies 2024-03-18 15:02:02 +01:00

License

This is a fork of node-irc, which is an IRC client library written in TypeScript for Node. This fork is used by the Matrix-IRC application service.

To use this package:

  yarn add matrix-org-irc

Differences from node-irc

The node-irc library isn't well maintained and there are a number of issues which are impacting development of the Matrix-IRC application service. We made the decision to fork the project in order to improve reliability of the application service. A summary of modifications from node-irc@0.3.12 are below:

  • TypeScript support
  • https://github.com/matrix-org/node-irc/pull/1 - Manifested as BOTS-80
  • https://github.com/matrix-org/node-irc/pull/4 - Manifested as [BOTS-73] (https://matrix.org/jira/browse/BOTS-73)
  • Handle +R - github.com/matrix-org/node-irc@7c16b994b1
  • Handle more error codes (430,435,438)
  • Fix bug which would fail to connect conflicting nicks which == NICKLEN.
  • Fix err_unavailresource on connection with reserved nicks.
  • Workaround for the Scunthorpe problem: https://github.com/matrix-org/matrix-appservice-irc/issues/103
  • Add methods for working out if a given text will be split and into how many lines.
  • Add names support (incl. multi-prefix).
  • Add functions to determine if a user prefix is more powerful than another (e.g. @ > &)
  • Case-map all incoming channels correctly (e.g on PRIVMSG and NOTICE)
  • Allow IP family to be chosen to allow IPv6 connections.
  • Add function for getting channel modes.
  • Workaround terrible RFC3484 rules which means that IPv6 DNS rotations would not be honoured.
  • Add setUserMode to set a user's mode.
  • Addition of encodingFallback option which allows setting encoding to use for non-UTF-8 encoded messages.
  • Addition of onNickConflict() option which is called on err_nicknameinuse. This function should return the next nick to try. The function defaults to suffixing monotonically increasing integers. Usage:
    new Client("server.com", "MyNick", {
       onNickConflict: function() {
         return "_MyNick_";
       }
    });