\n\n# discord-afk-js\n\n**[discord-afk-js](https://www.npmjs.com/package/discord-afk-js?activeTab=readme)** is a JavaScript library created to facilitate the management of AFK (Away From Keyboard) status within Discord bots. This library is designed to simplify the process of tracking and handling AFK users in a Discord server without the need for an external database.\n\n# Requirements\n\n- [NodeJS](https://nodejs.org) 18.x or higher\n\n# Installation\n\nTo start using **discord-afk-js**, you can install it through npm, the Node.js package manager. Open your terminal and run the following command:\n\n```bash\nnpm install discord-afk-js\n```\n\n# Usage\n\n**discord-afk-js** offers a straightforward way to manage AFK users in your Discord bot. Below is an example of how to utilize the **AfkClient** class:\n\n```javascript\nconst { AfkClient } = require('discord-afk-js');\n\n// Create an instance of AfkClient\nconst afk = new AfkClient();\n\n// ================================================================\n\n// Checking if a user is AFK without time\nafk.setUser({ id: 'id1', reason: 'Afk Playing Game' });\n\nconst [reason, time] = await afk.getReason('id1');\n\nif (afk.findUser('id1')) {\n console.log('User is marked as AFK'); // console: User is marked as AFK\n console.log('AFK Message:', `${reason} ${time}`); // console: AFK Message: Afk Playing Game a few seconds ago\n}\n\n// ================================================================\n\n// Adding a user to AFK status without reason\nafk.setUser({ id: 'id2' });\n\nif (afk.findUser('id2')) {\n console.log('User is marked as AFK'); // console: User is marked as AFK\n const [reason, time] = await afk.getReason('id2');\n\n console.log('AFK Message:', `${reason} ${time}`); // console: AFK Message: No Reason a few seconds ago\n}\n\n// ================================================================\n\n// Get reason without array\nafk.setUser({ id: 'id3' });\nconst reason = await afk.getReason('id3');\n\nconsole.log(reason); // console: No Reason a few seconds ago\n\n//================================================================\n\n// Removing a user from AFK status\nafk.removeUser('user123');\n```\n\nIn the code snippet above, we start by importing the **AfkClient** class. After creating an instance of this class, we demonstrate how to add a user to the AFK list, check their AFK status, and remove them from AFK status.\n\n# Changelog | Migrating to discord-afk-js\n\n```diff\n+ change afk to AfkClient for import\n+ afk.addUser() -> afk.setUser()\n+ afk.deleteUser() -> afk.removeUser()\n+ afk.getReason()\n```\n\n# License\n\nThis project is open-source and is licensed under the MIT License. You can find more details about the license in the [LICENSE.md](https://github.com/CyraTeam/discord-afk-js/blob/main/LICENSE) file included in the project.\n\nWith this comprehensive readme, you have a clear and detailed guide on how to use the **discord-afk-js** library to manage AFK status in your Discord bot.\n\n# Discord Servers\n\n![](\"https://nodei.co/npm/discord-afk-js.png?downloads=true&downloadRank=true&stars=true\")
\n ![\"node-current\"](\"https://img.shields.io/node/v/distube\")
![\"npm\"](\"https://img.shields.io/npm/dt/discord-afk-js\")
![\"npm](\"https://img.shields.io/npm/v/discord-afk-js/latest?color=blue&label=discord-afk-js%40latest&logo=npm\")
![\"GitHub](\"https://img.shields.io/github/stars/CyraTeam/discord-afk-js\")
![\"Discord\"](\"https://img.shields.io/discord/984857299858382908?label=CyraTeam&logo=discord\")
![\"Issues\"](\"https://img.shields.io/github/issues/CyraTeam/discord-afk-js\")
![\"Commit\"](\"https://img.shields.io/github/commit-activity/y/CyraTeam/discord-afk-js?label=Commit%20Activity&logo=github\")
![](\"https://codecov.io/gh/CyraTeam/discord-afk-js/graph/badge.svg?token=98ZKDNNXVE\"/){kind=icon}
\n