About The Project

Scrape online dictionaries to retrieve the IPA, definitions and examples sentences of a word.

Getting Started

Package manager

Using npm:

$ npm install dictionary-scraper

Using yarn:

$ yarn add dictionary-scraper

Once the package is installed, you can import the library using import or require approach:

import { DictionaryScraper } from 'dictionary-scraper';

const scraper = new DictionaryScraper();

You can also use the default import:

import DictionaryScraper from 'dictionary-scraper';

const scraper = new DictionaryScraper();

If you use require for importing:

const DictionaryScraper = require('dictionary-scraper');

const scraper = new DictionaryScraper.DictionaryScraper();

// Or object de-structuring:
const { DictionaryScraper } = require('dictionary-scraper');

const scraper = new DictionaryScraper();

Usage

 // Create a DictionaryScraper instance
 const scraper = new DictionaryScraper();

 // Call search method to fetch the lexical records
 console.log(scraper.search('hello'));
 {
   source: 'cambridge',
   sourceLinks: [
     'https://dictionary.cambridge.org/pronunciation/english/hello',
     'https://dictionary.cambridge.org/dictionary/english/hello',
   ],
   name: 'hello',
   entry: {
     ipaListings: {
       us: [{ category: '', ipa: '/heˈloʊ/', audio: 'https://dictionary.cambridge.org/media/english/us_pron/h/hel/hello/hello.mp3',}, ],
       uk: [{ category: '', ipa: '/heˈləʊ/', audio: 'https://dictionary.cambridge.org/media/english/uk_pron/u/ukh/ukhef/ukheft_029.mp3',}, ],
     },
     meanings: [{
         categories: 'exclamation, noun',
         entries: [
           {
             meaning: 'used when meeting or greeting someone:',
             examples: [
               "Hello, Paul. I haven't seen you for ages.",
               "I know her vaguely - we've exchanged hellos a few times.",
               "say hello I just thought I'd call by and say hello.",
               "a big hello And a big hello (= welcome) to all the parents who've come to see the show.",
             ],
           },
           ...
        ],
       },
       ...
     ],
   }
}

Full response sample can be found in docs/example-respopnse-hello.json and docs/example-response-present.json. See docs for more details.

Roadmap

• [ ] Add wiktionary

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Kamrul H Shourov - [email protected]

Project Link: https://github.com/khshourov/dictionary-scraper

Acknowledgments

• Great starter guide to build an NPM package
• Another good resource for building an NPM package
• Cambridge Online Dictionary
• Dictionary icons created by Smashicons - Flaticon