This repository has been archived by the owner on Jul 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bc31a5d
commit c7b56c5
Showing
1 changed file
with
103 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| [](https://github.com/greencoast-studios/djs-extended-data-provider-redis) | ||
| [](https://github.com/greencoast-studios/djs-extended-data-provider-redis) | ||
| [](https://www.npmjs.com/package/@greencoast/djs-extended-data-provider-redis) | ||
| [](https://www.npmjs.com/package/@greencoast/djs-extended-data-provider-redis) | ||
| [](https://www.npmjs.com/package/@greencoast/djs-extended-data-provider-redis) | ||
| [](https://www.npmjs.com/package/@greencoast/discord.js-extended) | ||
| [](https://www.npmjs.com/package/@greencoast/djs-extended-data-provider-redis) | ||
| [](https://www.npmjs.com/package/@greencoast/djs-extended-data-provider-redis) | ||
|
|
||
| # Discord.js - Extended / Redis Data Provider | ||
|
|
||
| [djs-extended-data-provider-redis](https://github.com/greencoast-studios/djs-extended-data-provider-redis) is an implementation of a | ||
| [DataProvider](https://docs.greencoaststudios.com/discord.js-extended/master/classes/Discord_js_Extended.DataProvider.html) for | ||
| [discord.js-extended](https://docs.greencoaststudios.com/discord.js-extended/master/index.html) made with a [Redis](https://www.npmjs.com/package/redis) backend. | ||
|
|
||
| > Keep in mind that Redis was originally meant to be a cache, data is deleted by default across | ||
| > service restarts. You can achieve persistence by [properly configuring](https://redis.io/topics/persistence) your | ||
| > Redis instance. | ||
| ## Usage | ||
|
|
||
| You can visit the [documentation site](https://docs.greencoaststudios.com/djs-extended-data-provider-redis/master) to see what this utility offers. | ||
|
|
||
| ### Installation | ||
|
|
||
| This package is designed to work for [discord.js](https://www.npmjs.com/package/discord.js) and [@greencoast/discord.js-extended](https://www.npmjs.com/package/@greencoast/discord.js-extended), | ||
| this does not install any of these packages, you are expected to have these in your project. | ||
|
|
||
| You can install this package with: | ||
|
|
||
| ```text | ||
| npm install discord.js @greencoast/discord.js-extended @greencoast/djs-extended-data-provider-redis | ||
| ``` | ||
|
|
||
| ## Adding the Data Provider to your Client | ||
|
|
||
| Assuming you have created your own [ExtendedClient](https://docs.greencoaststudios.com/discord.js-extended/master/classes/Discord_js_Extended.ExtendedClient.html), | ||
| you can attach this data provider into your client as such: | ||
|
|
||
| ```js | ||
| const { RedisDataProvider } = require('@greencoast/djs-extended-data-provider-redis'); | ||
|
|
||
| const client = new ExtendedClient(); | ||
|
|
||
| client.once('ready', async () => { | ||
| await client.setDataProvider(new RedisDataProvider(client, { | ||
| url: 'redis://localhost:6379' | ||
| })); | ||
| }); | ||
| ``` | ||
|
|
||
| And that's it! You can then access the data provider across your code through `client.dataProvider`. | ||
|
|
||
| ### Using Data Provider | ||
|
|
||
| You can use the following methods anywhere: | ||
|
|
||
| ```js | ||
| await client.dataProvider.get(guild, 'key'); // Get a value for 'key' in guild. | ||
| await client.dataProvider.set(guild, 'key', 'value'); // Set 'value' for 'key' in guild. | ||
| await client.dataProvider.delete(guild, 'key'); // Delete a key-value pair for 'key' in guild. | ||
| await client.dataProvider.clear(guild); // Clear all data in a guild. | ||
|
|
||
| await client.dataProvider.getGlobal('key'); // Get a value for 'key' in the global scope. | ||
| await client.dataProvider.setGlobal('key', 'value'); // Set 'value' for 'key' in the global scope. | ||
| await client.dataProvider.deleteGlobal('key'); // Delete a key-value pair for 'key' in the global scope. | ||
| await client.dataProvider.clearGlobal(); // Clear all data in the global scope. | ||
| ``` | ||
|
|
||
| If you're using TypeScript, you should pass a generic type to the `get` and `delete` methods as such: | ||
|
|
||
| ```ts | ||
| await client.dataProvider.get<string>(guild, 'key'); // Promise<string | undefined> | ||
| await client.dataProvider.get<string>(guild, 'key', 'default'); // Promise<string> | ||
|
|
||
| await client.dataProvider.delete<string>(guild, 'key'); // Promise<string | undefined> | ||
| ``` | ||
|
|
||
| ## Testing | ||
|
|
||
| You can run the unit tests for this package by: | ||
|
|
||
| 1. Cloning the repo: | ||
|
|
||
| ```text | ||
| git clone https://github.com/greencoast-studios/djs-extended-data-provider-redis | ||
| ``` | ||
|
|
||
| 2. Installing the dependencies. | ||
|
|
||
| ```text | ||
| npm install | ||
| ``` | ||
|
|
||
| 3. Running the tests. | ||
|
|
||
| ```text | ||
| npm test | ||
| ``` | ||
|
|
||
| ## Authors | ||
|
|
||
| This utility library was made by [Greencoast Studios](https://greencoaststudios.com). |