1.0.4 • Published 5 years ago

alimentometro-wrapper v1.0.4

Weekly downloads
4
License
MIT
Repository
github
Last release
5 years ago

Alimentômetro Wrapper

Build Status Coverage Status Badge size Badge gzip size

Wrapper para trabalhar com a Relação de Fatores de Correção e Índice de Conversão (Cocção de Alimentos).

Navegadores Suportados

Esta biblioteca faz uso da API de internacionalização que é suportada nos seguintes navegadores.

ChromeFirefoxOperaSafariIE
24+ ✔29+ ✔15+ ✔10+ ✔11+ ✔

Instalação

$ npm install alimentometro-wrapper --save

Como usar

ES6

import aw from 'alimentometro-wrapper';

aw.getAlimentos();

CommonJS

const aw = require('alimentometro-wrapper').default;

UMD no Navegador

<!-- importação da versão não minificada -->
<script src="alimentometro-wrapper.umd.js"></script>

<!-- importação da versão minificada -->
<script src="alimentometro-wrapper.umd.min.js"></script>

Depois disso, a biblioteca estará disponível globalmente como AlimentometroWrapper. Veja um exemplo:

AlimentometroWrapper.getAlimentos();

Métodos

Veja os métodos que a biblioteca fornece.

getAlimentos()

Busca os principais alimentos com informações de nome, fator de correção, índice de conversão e peso bruto equivalente a um grama de peso processado.

Exemplo

aw.getAlimentos()
  .map(alimento => {
    // faça o que quiser com os dados
  })

formata(peso)

Realiza a formatação de um valor númerico para o padrão humano para facilitar na leitura.

Parâmetros

ParâmetroTipoOpções
pesonumber'Peso em gramas'

Exemplo

aw.formata(1523); // saída: "1,523kg"

Contribuição

Leia CONTRIBUTING.md para obter detalhes sobre o processo de envio de pull requests.

Versionamento

É usado SemVer para controle de versão. Para as versões disponíveis, veja as tags.

Autor

Alan Pinhel
Alan Pinhel

Veja a lista dos contribuintes que participaram deste projeto.

Licença

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE.md para detalhes.