# schema-recipes

> This library provides functions to retrieve recipe data from any website URL. The website data must be in schema.org format https://schema.org/.

Latest version **1.0.5** (published 2022-08-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install schema-recipes
pnpm add schema-recipes
yarn add schema-recipes
bun add schema-recipes
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2022-08-03 |
| First published | 2022-07-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 36.2 KB |
| Known vulnerabilities | 0 (+24 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | j0bIT |
| Maintainers | j0bit |
| Keywords | recipes, schema, schema.org, fetch, convert, extract |

## Links

- npm: https://www.npmjs.com/package/schema-recipes
- Repository: https://github.com/Creet-Studios/schema-recipes
- Homepage: https://github.com/Creet-Studios/schema-recipes#readme
- Issues: https://github.com/Creet-Studios/schema-recipes/issues
- npm.io page: https://npm.io/package/schema-recipes

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [schema-dts](https://npm.io/package/schema-dts.md) ^1.1.0
- [tinyduration](https://npm.io/package/tinyduration.md) ^3.2.2

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2022-08-03
- 1.0.4 — 2022-08-02
- 1.0.3 — 2022-08-02
- 1.0.2 — 2022-07-03
- 1.0.1 — 2022-07-03
- 1.0.0 — 2022-07-03

## README

# schema-recipes

This library provides functions to retrieve recipe data from any website URL. The website data must be in schema.org format https://schema.org/.

The recipe schema data can be converted into a structured recipe object.

Get the recipe as a structured object:
```JS
const recipe = await getRecipe('https://<example.com/recipe>');
```

Get only the schema.org recipe format:
```JS
const recipe = await getSchemaRecipe('https://<example.com/recipe>');
```

Get a website info in the schema.org format:
```JS
const recipe = await getSchemaWebSite('https://<example.com>');
```

---
_Source: https://npm.io/package/schema-recipes · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._