Package Exports

cookbook.js
cookbook.js/lib/cookbook.min.cjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cookbook.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

📚 cookbook.js

npm version npm downloads license

📦 Welcome to cookbook.js, a versatile library designed to simplify recipe retrieval from tudoreceitas.com.

Overview

Cookbook.js offers a straightforward and intuitive interface for accessing a vast collection of recipes available on tudoreceitas.com.. With just a few lines of code, you can seamlessly integrate recipe fetching functionality into your project.

Installation

To install cookbook.js, simply run the following command in your project directory:

npm install cookbook.js

Usage

Getting started with cookbook.js is quick and easy. Once installed, you can use it to retrieve recipes with minimal effort.

Example:

const cookbook = require('cookbook.js');

// Retrieve a recipe
cookbook('chocolate cake', { format: true }).then(data => console.log(data));

Response Format

When you request a recipe, you'll receive a detailed object containing various attributes. Here's an overview of the response format:

{
    "title": "String",
    "description": "String",
    "imageUrl": "String",
    "category": { "name": "String", "link": "String" },
    "url": "String",
    "author": { "name": "String", "avatarUrl": "String" },
    "published_at": "String",
    "review": { "stars": "Number", "votes": "Number" },
    "comments": "Array",
    "duration": "String",
    "dificulty": "String",
    "ingredients": "Array",
    "instructions": "Array",
    "similar": "Array",
    "responseTime": "Number"
}

Contribution

We welcome contributions from the community to make cookbook.js even better. If you have ideas for improvements, bug fixes, or new features, feel free to submit a pull request on GitHub. Your contributions are greatly appreciated! 🚀