A minimal, fetch-based JavaScript & TypeScript client for the free Dictionary API that uses native fetch, works in Node.js (18+) and modern browsers and supports javascript and typescript.
npm install dictionary-api-clientNote: If you are using Node.js, ensure your project supports ES modules.
- Lookup word definitions using a public dictionary API
- Automatically encodes words with spaces or special characters
- Clean success / failure response contract
import { getDefinitionFor } from "dictionary-api-client";
const res = await getDefinitionFor({ word: "white" });
console.log(res);- Success Response Schema
{
"code": "api-ok",
"message": "No error encountered",
"payload": [
{
"word": "white",
"phonetic": "/waɪt/",
"phonetics": [
{
"text": "/waɪt/",
"audio": "https://api.dictionaryapi.dev/media/pronunciations/en/white-uk.mp3"
}
],
"meanings": [
{
"partOfSpeech": "noun",
"definitions": [
{
"definition": "The color of snow or milk; light containing all visible wavelengths."
}
]
},
{
"partOfSpeech": "adjective",
"definitions": [
{
"definition": "Bright and colourless; reflecting equal quantities of visible light.",
"example": "Write in black ink on white paper."
}
]
}
]
}
]
}- Error Response Schema
{
"code":"api-fail",
"message":"Not Found",
"payload": {
"title":"No Definitions Found",
"message":"Sorry pal, we couldn't find definitions for the word you were looking for.",
"resolution":"You can try the search again at later time or head to the web instead."
}
}PASS src/get-definition-for/test/index.test.ts
getDefinitionFor
✓ throws when global fetch is unavailable
✓ returns api-ok and payload when response ok
✓ returns api-fail when response.ok is false
✓ returns api-fail when fetch throws
✓ targets the dictionary api root url
Test Suites: 1 passed, 1 total
Tests: 5 passed, 5 total
Snapshots: 0 total
----------|---------|----------|---------|---------|-------------------
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
----------|---------|----------|---------|---------|-------------------
All files | 100 | 100 | 100 | 100 |
index.ts | 100 | 100 | 100 | 100 |
----------|---------|----------|---------|---------|-------------------
Like this project? Support it with a github star, it would mean a lot to me! Cheers and Happy Coding.