# duden

> ![Logo](https://www.duden.de/sites/default/res/duden.svg)

Latest version **1.1.1** (published 2022-12-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install duden
pnpm add duden
yarn add duden
bun add duden
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2022-12-12 |
| First published | 2022-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 21.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Finn |
| Maintainers | spantey |
| Keywords | duden |

## Links

- npm: https://www.npmjs.com/package/duden
- npm.io page: https://npm.io/package/duden

## Dependencies (2)

- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.0
- [node-html-parser](https://npm.io/package/node-html-parser.md) ^6.1.4

## Recent versions

- 1.1.1 (latest) — 2022-12-12
- 1.1.0 — 2022-12-12

## README

![Logo](https://www.duden.de/sites/default/res/duden.svg)

# Duden

Dadurch, dass ich es leid bin, auf eine Seite zu gehen und etwas zu suchen, wo es mehr Werbung gibt als im restlichen Universum, dachte ich mir dieses Paket zu erstellen, welches quasi alle Informationen, die zu einem Wort zu finden sind, wiedergibt.

Da das Ergebnis als JSON zurückgegeben wird, kann es ganz einfach als persönliche API für den eigenen Gebrauch genutzt werden ;)

Eigentlich war dieses Paket für mich persönlich gedacht, um damit eine KI zu trainieren, um anderen beim Lernen der Sprache zu helfen, aber dachte mir, dass es eventuell noch andere Leute geben könnte, die das auch vorhaben, aber von der Werbung genervt sind.

Die Idee basiert auf dem folgenden Paket: https://www.npmjs.com/package/duden-search-api aber wurde und wird erweitert.

## Installation

Zum installieren des Paketes, nutze folgenden Befehl:

```bash
  npm install duden
```

## Features

-   Nach Wort suchen
-   Festlegen wie viele Ergebnisse zurückgeliefert werden sollen
-   Mentor

## Beispiel nach Wort suchen

```javascript
import Duden from 'duden'

// Dem Konstruktor kann eine Zahl mitgegeben werden. Diese Zahl legt die Anzahl
// der zu erhaltenden Ergebnisse fest.

const duden = new Duden(1);

const data = await duden.search("Schule");

console.log(data);
<!--

  [
    {
      link: 'https://www.duden.de/rechtschreibung/Schule',
      word: 'Schule',
      article: 'die',
      wordClass: { string: 'Substantiv, feminin', array: [Array] },
      frequency: 'Gehört zu den 1000 häufigsten Wörtern im Dudenkorpus mit Ausnahme der Top 100',
      pronunciation: [ [Object] ],
      phoneticSpelling: [ '' ],
      spelling: { wordSeperation: [Object], examples: [Array] },
      meanings: [
        [Object], [Object],
        [Object], [Object],
        [Object], [Object],
        [Object], [Object]
      ],
      synonyms: [
        '(gehoben) Bildungsstätte; (Schülersprache) Penne; (Amtssprache) Bildungsanstalt',
        'Lehranstalt'
      ]
    }
  ]

 -->
```

## Beispiel zum nutzen des Mentors

```javascript
import Duden from 'duden'

// Dem Konstruktor kann eine Zahl mitgegeben werden. Diese Zahl legt die Anzahl
// der zu erhaltenden Ergebnisse fest.

const duden = new Duden(1);

// Dem Mentor wird ein Text übergeben, welcher dann auf Fehler überprüft wird.
// Ebenfalls kann noch optional eine Zahl angeben werden, welche festlegt wie viele Vorschläge maximal erstellt werden sollen.

const mentor = await duden.mentor(
    "Dadurch, dass ich es leid bin, auf eine Seite zu gehen und etwas zu suchen, wo es mehr Werbung gibt als im restlichen Universum, dachte ich mir dieses Paket zu erstellen, welches quasi alle Informationen, die zu einem Wort zu finden sind, wiedergibt.\n\nDa das Ergebnis als JSON zurückgegeben wird, kann es ganz einfach als persönliche API für den eigenen Gebrauch genutzt werden;)\n\nEigentlich war dieses Paket für mich persönlich gedacht, um damit eine KI zu trainieren, um anderen beim Lernen der Sprache zu helfen, aber dachte mir, dass es eventuell noch andere Leute geben1 könnte, die das auch vorhaben, aber von der Werbung genervt sind.\n\nDie Idee basiert auf dem folgenden Paket: https://www.npmjs.com/package/duden-search-api aber wurde und wird erweitert."
);

console.log(data);
<!--

{
    "data": {
        "spellAdvices": [
            {
                "errorCode": "21",
                "errorMessage": "<p>Diese Schreibweise ist unbekannt. Bitte überprüfen Sie die Rechtschreibung.</p>\n",
                "shortMessage": "Bitte Schreibweise überprüfen.",
                "length": 4,
                "offset": 272,
                "originalError": "JSON",
                "proposals": [
                    "Jason",
                    "Jon",
                    "Son",
                    "Ison"
                ],
                "synonyms": [],
                "occurrences": [
                    {
                        "offset": 272,
                        "text": "JSON",
                        "synonyms": []
                    }
                ],
                "occurrenceIndex": 0,
                "type": "orth",
                "additionalInformation": ""
            },
            {
                "errorCode": "21",
                "errorMessage": "<p>Diese Schreibweise ist unbekannt. Bitte überprüfen Sie die Rechtschreibung.</p>\n",
                "shortMessage": "Bitte Schreibweise überprüfen.",
                "length": 6,
                "offset": 569,
                "originalError": "geben1",
                "proposals": [],
                "synonyms": [],
                "occurrences": [
                    {
                        "offset": 569,
                        "text": "geben1",
                        "synonyms": []
                    }
                ],
                "occurrenceIndex": 0,
                "type": "orth",
                "additionalInformation": ""
            },
            {
                "errorCode": "21",
                "errorMessage": "<p>Diese Schreibweise ist unbekannt. Bitte überprüfen Sie die Rechtschreibung.</p>\n",
                "shortMessage": "Bitte Schreibweise überprüfen.",
                "length": 5,
                "offset": 685,
                "originalError": "https",
                "proposals": [
                    "HTTPS"
                ],
                "synonyms": [],
                "occurrences": [
                    {
                        "offset": 685,
                        "text": "https",
                        "synonyms": []
                    }
                ],
                "occurrenceIndex": 0,
                "type": "orth",
                "additionalInformation": ""
            }
        ],
        "styleAdvices": []
    }
}

 -->
```

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