Giter Club home page Giter Club logo

brazil-currencies's Introduction

About

EN

Brazil Currencies is a set of javascript functions that allow you to search brazil currencies in history. It is possible to find out which was the Brazilian currency on a specific date. You also can get currencies by name, symbol, and more.

PT

Brazil Currencies (Moedas do Brasil) é um conjunto de funções que te permite consultar as moedas brasileiras na história. É possível consultar qual era a moeda brasileira em um data específica. Você também pode consultar as moedas por nome, símbolo entre outras coisas. Clique aqui para ver o readme em português.

Install

$ npm i brazil-currencies

Usage

import {
    getUniqueNames, 
    getUniqueSymbols, 
    getCurrencyByName, 
    getCurrencyBySymbol, 
    getCurrencyByDate, 
    getAllCurrencies
} from 'brazil-currencies'

console.log(getUniqueNames().join(', '));
//Réis, Mil Réis, Cruzeiro, Cruzeiro Novo, Cruzado, Cruzado Novo, Cruzeiro Real, Real

console.log(getUniqueSymbols().join(', '));
//R, Rs, Cr$, NCr$, Cz$, NCz$, CR$, R$

console.log(getCurrencyByName('real'));
//[{name: "Real", symbol: "R$", startDate: Fri Jul 01 1994 00:00:00 GMT-0300 (Horário Padrão de Brasília), endDate: null}]

console.log(getCurrencyBySymbol('Cr$'));
//[{name: "Cruzeiro", symbol: "Cr$", startDate: /*date*/, endDate: /*date*/}, {/*obj2*/}, {/*obj3*/}]

console.log(getCurrencyByDate(new Date(1899, 10, 10)));
//{name: "Mil Réis", symbol: "Rs", startDate: /*date*/, endDate: /*date*/}

console.log(getAllCurrencies());
//[/*all currencies*/]

Currency Interface definition

interface Currency {
    name: string;
    symbol: string;
    startDate: Date;
    endDate: Date | null;
}

Run example

Make sure you have a recent version of Node.js installed in your development environment.

Cloning Repository

$ git clone https://github.com/rodrigues-t/brazil-currencies.git

Installing all dependencies (library and playground)

$ cd brazil-currencies && npm run i-all

Runinng for test

$ npm run dev

Functions

Name Description Parameter Return
getAllCurrencies Get the list of all currencies in the history Array<Currency>
getCurrencyBySymbol Get currencies by the symbol (Can be more than one) symbol: string Array<Currency>
getCurrencyByName Get currencies by the name (Can be more than one) name: string Array<Currency>
getCurrencyByDate Get currency by the date date: Date Currency
getUniqueSymbols Get all unique symbols Array<string>
getUniqueNames Get all unique names Array<string>

brazil-currencies's People

Contributors

rodrigues-t avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.