npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

currency-exchanger-js

v1.0.4

Published

A light-weight currency converter module that fetches currency exchange rates daily

Downloads

514

Readme

Currency Exchanger JS

A light-weight currency converter module that fetches exchange rates daily from here.

Getting Started

Installation

This package can be installed using npm

npm install currency-exchanger-js

or yarn

yarn add currency-exchanger-js

Usage

Import currency-exchanger-js.

const converter = require('currency-exchanger-js');

Use the function you require. There are 2 available functions: convertOnDate and convert.

convertOnDate

Parameters:
  • value: number
  • fromCurrency: string
  • toCurrency: string
  • inputDate: Date

Use this method when you need to convert between currencies using the exchange rates on a specific date.

This example converts 1SGD to MYR using the exchange rates on 12th August 2022. Since it returns a promise, you need to use await.

const sgdToMyr = await converter.convertOnDate(1, "sgd", "myr", new Date("2022-08-12"));

Alternatively, you could use then.

converter.convertOnDate(1, "sgd", "myr", new Date("2022-08-12")).then((res) => {
  console.log(res)); // or do something else
});

Note that the date input accepts any valid JavaScript Date object. To find out the possible ways to instantiate valid Date objects, refer here.

convert

Parameters:
  • value: number
  • fromCurrency: string
  • toCurrency: string

Use this method when you need to convert between currencies using the exchange rates of today. Similarly, it returns a promise. The following examples show how you can convert 5SGD to MYR using today's exchange rates.

const sgdToMyr = await converter.convert(5, "sgd", "myr");
converter.convert(5, "sgd", "myr").then((res) => {
  console.log(res)); // or do something else
});

Currency

For the currency strings (specifically fromCurrency and toCurrency), please refer to the keys of this JSON here. These are internationally recognized currency acronyms.

Limitations

Due to having dependencies on another repo, it faces the same limitations as that repo, mainly being:

  • Historical exchange rates do not go further than 1st Jan of last year
  • There could be a possibility of some dates being missing if the scripts from that repo messes up

Issues

If you find any issues, please report them ❗here

License

This project is licensed under the ISC license.

Final Messages

Please do star this repo by clicking on the ⭐ button at the top right of this repo!