Nighttime Pachinko Marathon

    nutri-score
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.4 • Public • Published

    Nutri-Score Calculator

    Nutri Score logo

    The goal of the project is to provide simple library that can calculate the Nutri-Score.

    Release GitHub code size in bytes Codacy Badge Dependencies Build Status

    What is Nutri-score

    Nutri-Score, an indicator of nutritional quality

    With a release date of November 2017, the Nutri-Score is by definition a new labeling system that indicates the nutritional values ​​of a product in a more simplified way. So, what is it exactly? Attached to the front of packaging, it complements the mandatory nutrition declaration required by the European Commission regulations in force.

    Its goal is to help consumers turn to wholesome, healthy and healthy foods, and to know exactly what to choose to fight junk food.

    The Nutri-Score comes in the form of a logo with a 5-level scale, from the most favorable product to the least favorable nutritionally. niwali keto The device thus consists of 5 colors ranging from dark green to dark orange, and 5 letters ranging from A to E. Each color is associated with a letter.

    Class A products are therefore considered to be the healthiest. On the other hand, when the label has a qualification approaching the letter E, it means that the food is considered too fat, too sweet or too salty.

    Quote from http://www.purebodyformation.net/nutri-score-work/

    Usage

    Usage in browser

    1. Import the library:
    <script src="https://cdn.jsdelivr.net/npm/nutri-score/nutriScore.js"></script>
    1. Use it to calculate the nutri-score class like so:
    const nutriScoreResult = nutriScore.nutriScore.calculateClass(
      {
        energy: 0,
        fibers: 4,
        fruit_percentage: 60,
        proteins: 2,
        saturated_fats: 2,
        sodium: 500,
        sugar: 10
      },
      "solid"
    );
     
    console.log(nutriScoreResult); // Output: "B"

    For more methods & usage refer to the documentation bellow

    Usage in JavaScript / TypeScript projects

    1. Install the library
    yarn add nutri-score

    or

    npm install nutri-score --save
    
    1. Include the library in your project:
    import { nutriScore } from "nutri-score";
    1. Use it to calculate the nutri-score class like so:
    const nutriScoreResult = nutriScore.calculateClass(
      {
        energy: 0,
        fibers: 4,
        fruit_percentage: 60,
        proteins: 2,
        saturated_fats: 2,
        sodium: 500,
        sugar: 10
      },
      "solid"
    );
     
    console.log(nutriScoreResult); // Output: "B"

    Note: TypeScript definition are included in the project

    Documentation

    ... Work in progress ...

    Contribution

    Feel free to add suggestions, PRs, comments and bug reports.

    Authors

    Alex Kolarski (aleks.rk@gmail.com)

    License

    (The MIT License)

    Copyright (c) 2019

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i nutri-score

    DownloadsWeekly Downloads

    5

    Version

    0.2.4

    License

    MIT

    Unpacked Size

    43.6 kB

    Total Files

    28

    Last publish

    Collaborators

    • kolarski