{"id":19789509,"url":"https://github.com/webfreak001/hack.chat.js","last_synced_at":"2025-08-10T23:34:12.097Z","repository":{"id":35028232,"uuid":"39137621","full_name":"WebFreak001/hack.chat.js","owner":"WebFreak001","description":"*No longer maintained* API wrapper for hack.chat using ws package","archived":false,"fork":false,"pushed_at":"2015-07-24T10:28:09.000Z","size":154,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-02-28T14:47:01.151Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WebFreak001.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-15T13:13:29.000Z","updated_at":"2023-11-14T07:53:45.000Z","dependencies_parsed_at":"2022-09-15T23:40:12.118Z","dependency_job_id":null,"html_url":"https://github.com/WebFreak001/hack.chat.js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/WebFreak001/hack.chat.js","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebFreak001%2Fhack.chat.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebFreak001%2Fhack.chat.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebFreak001%2Fhack.chat.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebFreak001%2Fhack.chat.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WebFreak001","download_url":"https://codeload.github.com/WebFreak001/hack.chat.js/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WebFreak001%2Fhack.chat.js/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269805790,"owners_count":24478048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T06:33:47.873Z","updated_at":"2025-08-10T23:34:12.076Z","avatar_url":"https://github.com/WebFreak001.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hack.chat.js\n\n[![npm package 1.2.0](https://badge.fury.io/js/hack-chat.svg)](https://www.npmjs.com/package/hack-chat)\n\nAPI wrapper for hack.chat using ws package\n\n## Usage\n\n```js\nvar HackChat = require(\"hack-chat\");\nvar chat = new HackChat(); // Client group for multiple channels\nchat.join(\"lobby\", \"TestUser\");\nvar programmingSession = chat.join(\"programming\", \"TestUser\");\n\nchat.on(\"onlineSet\", function(session, users) {\n    // Each event from a group contains a session argument as first argument\n    console.log(\"Users online in ?\" + session.channel + \": \" + users.join(\", \"));\n});\n\nchat.on(\"chat\", function(session, nick, text) {\n    console.log(nick + \"@\" + session.channel + \": \" + text);\n\n    if (session.channel != \"programming\") {\n        programmingSession.sendMessage(\"Quote from ?\" + session.channel + \": \" + text);\n    }\n});\n```\n\n## HackChat.Session methods\n\n### `new(channel: string, username: string, password?: string, options?: any = { server: \"wss://hack.chat/chat-ws\" })`\n\n**Description:** Constructs a new chat session and directly connects to it\n\n**Example:**\n```js\nvar session = new HackChat.Session(\"programming\", \"My_Username\", \"password123\", { server: \"wss://custom-server.com/chat-ws\" });\n```\n\n### `sendRaw(json: any)`\n\n**Description:** Sends a raw JSON packet\n\n**Example:**\n```js\nsession.sendRaw({ cmd: \"ping\" });\n```\n\n### `sendMessage(message: string)`\n\n**Description:** Sends a chat message\n\n**Example:**\n```js\nsession.sendMessage(\"Hi everybody\");\n```\n\n### `invite(user: string)`\n\n**Description:** Invites a user to a random channel\n\n**Example:**\n```js\nsession.on(\"invited\", function(nick, channel, time) {\n    var invitedSession = chat.join(channel, \"My_Username\", \"password123\");\n    invitedSession.once(\"onlineAdd\", function(nick, time)\n    {\n        invitedSession.sendMessage(\"Hi, \" + nick);\n    });\n});\n\nsession.invite(\"WebFreak\");\n```\n\n### `ping()`\n\n**Description:** Sends a ping packet. Can be used to check IP limit.\n\n### `leave()`\n\n**Description:** Disconnects from the server, making `this` unusable\n\n## HackChat.Session events\n\n**All HackChat events are the same as the HackChat.Session events with the exception that the session where it got emitted from is the first argument**\n\n### `.on(\"joining\")`\n\n**Description:** Emitted when sending the join request.\n\n**Arguments:** None\n\n### `.on(\"left\")`\n\n**Description:** Emitted when disconnected from WebSocket.\n\n**Arguments:** None\n\n### `.on(\"chat\")`\n\n**Description:** Emitted when someone sends a regular message.\n\n**Arguments:**\n* `nick` (String)\n* `text` (String)\n* `time` (Number, Unix Time)\n* `isAdmin` (Boolean)\n* `trip` (String) - Hash from password\n\n### `.on(\"info\")`\n\n**Description:** Emitted when some unhandled info event passes through.\n\n**Arguments:**\n* `text` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"infoRaw\")`\n\n**Description:** Emitted when any info event occurs. Will also trigger if it gets handled.\n\n**Arguments:**\n* `text` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"warn\")`\n\n**Description:** Emitted when some unhandled warn event passes through.\n\n**Arguments:**\n* `text` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"warnRaw\")`\n\n**Description:** Emitted when any warn event occurs. Will also trigger if it gets handled.\n\n**Arguments:**\n* `text` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"ratelimit\")`\n\n**Description:** Emitted when server is sending IP ratelimit warning. Will cancel regular warn event.\n\n**Arguments:**\n* `time` (Number, Unix Time)\n\n### `.on(\"banned\")`\n\n**Description:** Emitted when admin is banning the user. Will cancel regular warn event.\n\n**Arguments:**\n* `time` (Number, Unix Time)\n\n### `.on(\"nicknameInvalid\")`\n\n**Description:** Emitted when nickname trying to join with is invalid (\"!\", \"$\", \"?\", etc.) Will cancel regular warn event.\n\n**Arguments:**\n* `time` (Number, Unix Time)\n\n### `.on(\"nicknameTaken\")`\n\n**Description:** Emitted when nickname trying to join with is already taken. Will cancel regular warn event.\n\n**Arguments:**\n* `time` (Number, Unix Time)\n\n### `.on(\"invited\")`\n\n**Description:** Emitted when WebSocket successfully invited someone. Will cancel regular info event.\n\n**Arguments:**\n* `nick` (String)\n* `channel` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"invitation\")`\n\n**Description:** Emitted when someone invited WebSocket. Will cancel regular info event.\n\n**Arguments:**\n* `nick` (String)\n* `channel` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"onlineSet\")`\n\n**Description:** Emitted when successfully joined. Will contain an array of users.\n\n**Arguments:**\n* `nicks` (String[])\n* `time` (Number, Unix Time)\n\n### `.on(\"onlineAdd\")`\n\n**Description:** Emitted when someone joins the channel.\n\n**Arguments:**\n* `nick` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"onlineRemove\")`\n\n**Description:** Emitted when someone leaves the channel.\n\n**Arguments:**\n* `nick` (String)\n* `time` (Number, Unix Time)\n\n### `.on(\"error\")`\n\n**Description:** Emitted when receiving invalid JSON or if WebSocket fails to send.\n\n**Arguments:**\n* `exception` (any)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebfreak001%2Fhack.chat.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebfreak001%2Fhack.chat.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebfreak001%2Fhack.chat.js/lists"}