https://github.com/coderwelsch/duden-search-api
A Node.js website scraper for searching of german words on duden.de
https://github.com/coderwelsch/duden-search-api
Last synced: about 1 year ago
JSON representation
A Node.js website scraper for searching of german words on duden.de
- Host: GitHub
- URL: https://github.com/coderwelsch/duden-search-api
- Owner: Coderwelsch
- License: mit
- Created: 2017-05-08T17:49:42.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T13:06:10.000Z (over 3 years ago)
- Last Synced: 2025-04-14T23:05:48.667Z (about 1 year ago)
- Language: JavaScript
- Size: 144 KB
- Stars: 23
- Watchers: 3
- Forks: 5
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# duden-search-api

A Node.js Duden.de 'API' (website scraper for searching of german words on duden.de)
## Install
```bash
npm i duden-search-api --save
```
## Usage
````javascript
const DudenSearchApi = require( "duden-search-api" );
let instance = new DudenSearchApi();
instance.search( "gestern" ).then( ( result ) => {
console.log( result );
} ).catch( ( error ) => {
console.log( error );
} );
````
### The result array
The resulted return value is in the following scheme:
```javascript
[
{
"word": "gestern",
"props": {
"wordClass": "Adverb",
"hyphenation": [
"ges",
"tern"
],
"meanings": [
"an dem Tag, der dem heutigen unmittelbar vorausgegangen ist",
"früher"
],
"ancestry": "mittelhochdeutsch gester(n), althochdeutsch gesteron, eigentlich = am anderen Tag"
}
}
]
```
## Todo
- [x] simple word search
- [x] extend word results (distribution, hyphenation, ancestry, examples)
- [ ] documentation ;)
- [ ] …