Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 1.42 KB

README.md

File metadata and controls

77 lines (58 loc) · 1.42 KB

mw-dict

Node.js Wrapper for Merriam Webster Dictionary Developer API

  • Supports Collegiate® Dictionary & Learner's Dictionary
  • Supports Collegiate® Thesaurus
  • Exports word senses with hierarchy (sense, subsense...)
  • Outputs pronunciation audio url
  • Cares about functional label, synonyms, verbal illustrations ...
  • Outputs popularity

Preview:

'screen shot'

Note: Please get your API Key from Merriam-Webster's Developer Center

install

npm install mw-dict

usage

import { CollegiateDictionary, LearnersDictionary, CollegiateThesaurus } from 'mw-dict'

const dict = new CollegiateDictionary(API_KEY)
// const dict = new LearnersDictionary(API_KEY)
// const thesaurus = new CollegiateThesaurus(API_KEY)

dict
  .lookup(QUERY_WORD)
  .then(result => {})
  .catch(error => {})

result interface

// result: Definition[]
// Definition
{
  word: String,
  functional_label: String,
  pronunciation: String[],
  definition: Sense[],
  popularity: String
}
// Sense
{
  number: String,
  meanings: String[],
  synonyms: String[],
  antonyms: String[],
  illustrations: String[],
  senses: Sense[]
}

Error handler

import { WordNotFoundError } from 'mw-dict'

dict
  .lookup(QUERY_WORD)
  .catch(error => {
    if (error instanceof WordNotFoundError) {
      // error.suggestion
    }
  })