@soufantech/ephemeral-codes

Manages temporary codes for password recovery, user registration and other use cases.

💾 Installation:

@soufantech/ephemeral-codes depends on ioredis version ^4. Be sure to install it if you don't have it already in your project.

You can install this package (and ioredis) with yarn:

yarn add ioredis@^4 @soufantech/ephemeral-codes

or npm:

npm install ioredis@^4 @soufantech/ephemeral-codes

🚴 Usage:

Usage documentation hasn't been provided yet. Please, refer to the tests for usage examples.

🔤 API docs:

API documentation hasn't not been provided yet. Please, refer to the source code.

🧪 Testing:

1. Copy the contents of the .env.example file to an .env file in the same directory.
2. Run docker-compose up to spin up a redis container.
3. Run yarn test (or npm run test) to execute the tests.

---

_{Built with ❤︎ by SouFan}