Skip to content

Improved the explanation of how rate caching works in the readme file #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
olarotseyi wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improved the explanation of how rate caching works in the readme file #54

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a8a7ef
Improved readme
olarotseyi Jul 2, 2023
33f3376
Merge branch 'master' of https://github.com/olarotseyi/nodejs-currenc…
olarotseyi Jul 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ currencyConverter.rates().then((response) => {

Rates can be cached for currency pairs. To implement rate caching, instantiate an object of CurrencyConverter only once in your project, in a CurrencyConverter file, and setup rates caching then import the instance of CurrencyConverter from the CurrencyConverter file in your project across the rest of your project. Use chaining to convert currencies when caching is implemented. Below is an example of a CurrencyConverter file.

Note: Rates are not actually deleted after the ratesCacheDuration. The rate remains in the rates cache of the CurrencyConverter object until a request is made for the same currency pair at which point, the old rate is overwritten.
Note: Rates are not actually deleted after the ratesCacheDuration. The rate remains in the rates cache of the CurrencyConverter object until a request is made for the same currency pair after the rates cache duration has been exceeded at which point, the old rate is overwritten.

```javascript
const CC = require('currency-converter-lt')
Expand Down