https://github.com/vegeta897/eris-json

A helper utility for writing Eris objects to JSON
https://github.com/vegeta897/eris-json

debug debugger deprecated discord eris helper json utility

Last synced: 3 days ago
JSON representation

A helper utility for writing Eris objects to JSON

• Host: GitHub
• URL: https://github.com/vegeta897/eris-json
• Owner: vegeta897
• License: mit
• Created: 2019-01-22T01:00:19.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-02-05T13:13:49.000Z (almost 4 years ago)
• Last Synced: 2024-10-30T13:11:42.922Z (8 days ago)
• Topics: debug, debugger, deprecated, discord, eris, helper, json, utility
• Language: JavaScript
• Homepage:
• Size: 7.81 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Eris JSON

=========

⛔️ `DEPRECATED` A helper utility for writing [Eris](https://abal.moe/Eris/) objects to JSON

**This library is out of date and no longer maintained.** It may still work but it will probably give incomplete output. Since I now use Typescript primarily, I don't have much need for this library anymore. If somebody wants to revive this in a PR or fork, they are welcome to.

Original Readme below

-----

```npm

npm install eris-json

```

Use Eris JSON to write your bot or message objects to JSON.

```js

const Eris = require('eris');

const ErisJSON = require('eris-json');

let bot = new Eris('BOT_TOKEN');

bot.on('ready', () => {

    ErisJSON.botToJSON(bot); // Write the bot's state to ./bot.json

});

bot.on('messageCreate', message => {

    ErisJSON.messageToJSON(message); // Write the message object to ./message.json

});

bot.connect();

```

Usage

-----

Any time after initializing your bot, you can call `ErisJSON.botToJSON(bot)` to write the bot object to a tab-indented JSON file in the root folder named `bot.json`. You may specify a different name or path:

```js

ErisJSON.botToJSON(bot, 'debug/client.json');

```

This function also returns the stringified JSON. If you just want to get the string and not write it to a file, pass in `false` as the second argument.

```js

let botJSON = ErisJSON.botToJSON(bot, false);

```

You can write `message` objects the same way from a `messageCreate` event using `ErisJSON.messageToJSON(message)`.

Why?

----

Eris has a lot of state data in its [client](https://abal.moe/Eris/docs/Client) object, as well as its [message](https://abal.moe/Eris/docs/Message) objects. I have found it useful to see it all laid out in a JSON file. But simply running `JSON.stringify()` on the objects do not yield the complete structure, due to the use of getters and maps. There is also some redundant or useless data that this utility ignores. Eris comes with `.toJSON()` functions for the client and messages, but these give incomplete results.

Notes

-----

Some redundancy is eliminated in the bot and message objects. For example, the Channel objects listed in a guild's `channels` property do not contain `guild` properties of their own. Also, message objects contain a `user` property instead of `author` or `member` properties. It will contain all of the added properties of a Member when the message comes from a guild channel.

Collections (or maps) are converted to arrays. Maybe they should be converted to objects instead. Tell me what you think.

My sincere thanks and appreciation to [abalabahaha](https://github.com/abalabahaha) for their awesome library.