Git Product home page Git Product logo

nutrifacts.js's Introduction

Build Status

Nutrifacts.js

A library to calculate nutrition facts, smartly. No third party services or remote DBs involved.

Nutrifacts.js is a library to extract and calculate nutrition facts, on several levels of detail; the library is capable of processing natural language strings and retrieving information using precise inputs (IDs or labels).

Quick example: https://repl.it/@MarcelloBarile/Nutrifactsjs


API

Returns the list of nutrients and properties from a given list of ingredients.

@param ingredients -- The list of ingredients. Supports NLP queries (recipeStr) or precise values (label & quantity).

getNutrientsInRecipe(ingredients: IInputIngredient[])

Returns the best matching food for a given textual query.

@param query -- The query to match.

getFoodByQuery(query: string, injectNutrients: boolean)

Returns a list of nutrients that matches the given query.

@param query -- The nutrients query to match.

getNutrientsByQuery(query: string)

Returns the food entity from a given ID.

@param id -- The food ID.

getFoodById(id: string)

Returns a list of foods that contains the given ingredients' IDs.

@param ingredientsIds -- The list of ingredients' IDs to match. @param operator -- The logic operator to be applied when matching the ingredients.

getFoodsByIngredients(ingredientsIds: number[], operator: LOGIC_OPERATOR)

Returns a list of foods that have properties which match the given query string.

@param query -- The properties query to match.

getFoodsByProperties(query: string)


Installation

$ npm install nutrifacts

or

$ yarn add nutrifacts

Development

See CONTRIBUTING.md


Todos

See TODOs.md


Changelog

See CHANGELOG.md


License

UNLICENSED

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.