https://github.com/pannh/le-robert
A library to scrap data from the French dictionary Le Robert
https://github.com/pannh/le-robert
conjugaison conjugation definition dictionary dictionnaire francais french le-robert verbe word word-data
Last synced: 4 months ago
JSON representation
A library to scrap data from the French dictionary Le Robert
- Host: GitHub
- URL: https://github.com/pannh/le-robert
- Owner: PannH
- License: other
- Created: 2023-08-14T12:33:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-14T16:27:39.000Z (almost 2 years ago)
- Last Synced: 2025-02-16T20:47:42.324Z (4 months ago)
- Topics: conjugaison, conjugation, definition, dictionary, dictionnaire, francais, french, le-robert, verbe, word, word-data
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/le-robert
- Size: 17.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📕 Le Robert
This library gives you access to French words data by scraping them from the dictionary Le Robert, one of the most famous French dictionaries, using [Puppeteer](https://pptr.dev/).
# 📥 Installation
### NPM
```bash
npm install le-robert
```
### Yarn
```bash
yarn add le-robert
```
### PNPM
```bash
pnpm add le-robert
```
# 🔧 Functions
Each function can be imported from the library as below 👇
```js
// Require syntax
const { getDefinitionGroups, getPronunciation, ... } = require('le-robert');
// Import syntax
import { getDefinitionGroups, getPronunciation, ... } from 'le-robert';
```
---
### `getDefinitionGroups(wordQuery: string): Promise`
#### Example
```js
await getDefinitionGroups('programmation'); // => https://sourceb.in/4rSVNnS0rQ
```
---
### `getPronunciation(wordQuery: string): Promise`
#### Example
```js
await getPronunciation('programmation'); // => https://sourceb.in/5rHNNIWFZD
```
---
### `getUsageExamples(wordQuery: string): Promise`
#### Example
```js
await getUsageExamples('programmation'); // => https://sourceb.in/IekuY8L8Jp
```
### `getConjugationGroups(verbQuery: string): Promise`
#### Example
```js
await getConjugationGroups('programmer'); // => https://sourceb.in/HZccVYUGzJ
```
---
# ⚙️ Types
Since some of the returned objects from the previous functions may be huge, here is the types to help you understand better how to use the data.
Also, you can use the intellisense of your editor to explore the data.
---
### `DefinitionGroup`
```ts
interface DefinitionGroup {
category: string;
definitions: Definition[];
}
```
---
### `Definition`
```ts
interface Definition {
value: string;
examples: string[];
context?: string;
}
```
---
### `Pronunciation`
```ts
interface Pronunciation {
audioURL: string;
}
```
---
### `UsageExample`
```ts
interface UsageExample {
value: string;
source: UsageExampleSource;
}
```
---
### `UsageExampleSource`
```ts
interface UsageExampleSource {
value: string;
url: string;
}
```
---
### `ConjugationGroup`
```ts
interface ConjugationGroup {
name: string;
subgroups: ConjugationSubgroup[];
}
```
---
### `ConjugationSubgroup`
```ts
interface ConjugationSubgroup {
name: string;
tenses: ConjugationTense[];
}
```
---
### `ConjugationTense`
```ts
interface ConjugationTense {
name: string;
conjugations: string[];
}
```