currency-conversion-lib-avilamelia
v2.0.6
Published
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Downloads
2
Readme
currency-conversion-lib
Introduction
-this is a crypto currency conversion lib, which you can convert the value of a crypto currency into another and consult the curent crypto currency quotes
Getting started
-First thing you will need is an api-key, you can acquire you for free in this webqsite https://coinmarketcap.com/api/
How to install dependencies
-You can install using npm or yarn -ex: yarn add currency-conversion-lib-avilamelia/ npm install currency-conversion-lib-avilamelia -After that you are ready to use it
How to use it
-First you will need to import the class in your project
- import {CryptoCurrency} from "currency-conversion-lib-avilamelia" -After that you will need to instanciate a variable as a new Cryptocurrency class. Exem: -const myCrypto = new CryptoCurrency(your api key) -Also you will have to pass your apikey as a parameter to the class, you dont pass, it wont work
Using the libs methods
-This library consists in two methods: conversion and quotes
- convertion: takes 3 arguments: amount:number, symbol:string, convert:string[] amount: is the amount that you want to convert symbol: Is the crypto currency that you will be converting into convert: Is the currencies like USD or BRL that you want to convert into the crypto currency value = quotes: it takes 1 argument which is an array of string: symbol:string[] -symbol: this argument is the crypto currencies that you want to know its quotes
-Now, with your variable instanciated you can use its methods. first the quotes method:
myCryptoVariable.quote(['BTC']).then((response)=>{console.log(response)})
-this code will return the following json
response 200
{
"data": {
"BTC": {
"id": 1,
"name": "Bitcoin",
"symbol": "BTC",
"slug": "bitcoin",
"date_added": "2013-04-28T00:00:00.000Z",
"last_updated": "2022-01-26T20:20:00.000Z",
"quote": {
"USD": {
"price": 36965.522480748834,
"last_updated": "2022-01-26T20:20:00.000Z"
}
}
}
}
}
-The conversion method is similar, the diference is that you will need to pass 3 arguments: myCryptoVariable.conversion(25, "BTC", ["NMC"]).then((res) => console.log(res));
this code will returning the following json:
response 200
{
"data": {
"id": 1,
"symbol": "BTC",
"name": "Bitcoin",
"amount": 20000,
"last_updated": "2022-01-26T20:28:00.000Z",
"quote": {
"NMC": {
"price": 500642083.02869165,
"last_updated": "2022-01-26T20:28:00.000Z"
}
}
}
}