Merge pull request #215 from codeoverflow-org/sample/irc

Add IRC sample

Author: hlxid

samples/irc/extension/index.ts

@@ -0,0 +1,23 @@
+import { NodeCG } from "nodecg/types/server";
+import { requireService } from "nodecg-io-core";
+import { IRCServiceClient } from "nodecg-io-irc";
+
+module.exports = function (nodecg: NodeCG) {
+    nodecg.log.info("Sample bundle for irc started.");
+
+    const service = requireService<IRCServiceClient>(nodecg, "irc");
+    service?.onAvailable((client) => {
+        nodecg.log.info("IRC client has been updated.");
+        client.join("#skate702"); // Change this channel, if you want to connect to a different channel.
+
+        client.addListener("message", (from, to, message) => {
+            nodecg.log.info(from + " => " + to + ": " + message);
+        });
+
+        client.addListener("error", function (message) {
+            nodecg.log.info("error: ", message);
+        });
+    });
+
+    service?.onUnavailable(() => nodecg.log.info("IRC client has been unset."));
+};

samples/irc/package.json

@@ -0,0 +1,24 @@
+{
+    "name": "irc",
+    "version": "0.1.0",
+    "private": true,
+    "nodecg": {
+        "compatibleRange": "^1.1.1",
+        "bundleDependencies": {
+            "nodecg-io-irc": "^0.1.0"
+        }
+    },
+    "scripts": {
+        "build": "tsc -b",
+        "watch": "tsc -b -w",
+        "clean": "tsc -b --clean"
+    },
+    "license": "MIT",
+    "dependencies": {
+        "@types/node": "^14.14.13",
+        "nodecg": "^1.7.4",
+        "nodecg-io-core": "^0.1.0",
+        "nodecg-io-irc": "^0.1.0",
+        "typescript": "^4.1.3"
+    }
+}

samples/irc/tsconfig.json

@@ -0,0 +1,3 @@
+{
+    "extends": "../../tsconfig.common.json"
+}