Miss any of our Open RFC calls?Watch the recordings here! »

owlbot-js

2.0.0 • Public • Published

alt text

owlbot-js

CircleCI Coverage Status

OwlBot is a free English dictionary API available on https://owlbot.info. This repository is a simple javascript client to fetch definitions of the words from the Owlbot API.

Quick start

First install the owlbot-js package.

npm install owlbot-js

Example Code:

var Owlbot = require('owlbot-js');
  
var client = Owlbot(YOUR_TOKEN);
 
client.define('owl').then(function(result){
   console.log(result);
});

In the example code, we've initiated the client object with a token. you can register for a free token on https://owlbot.info.

Then on the client instance we called the define method to fetch the definitions of the word 'owl'. In the background, define method sends an ajax request to the API using the axios package. Since it's an asynchronous request, the define methos returns a Promiss.

result:
{ definitions:
   [ { type: 'noun',
       definition:
        'a nocturnal bird of prey with large eyes, a facial disc, a hooked beak, and typically a loud hooting call.',
       example:
        'I love reaching out into that absolute silence, when you can hear the owl or the wind.',
       image_url:
        'https://media.owlbot.info/dictionary/images/owl.jpg.400x400_q85_box-403,83,960,640_crop_detail.jpg',
       emoji: '🦉' } ],
  word: 'owl',
  pronunciation: 'oul' }
 
 

Install

npm i owlbot-js

DownloadsWeekly Downloads

18

Version

2.0.0

License

MIT

Unpacked Size

7.51 kB

Total Files

7

Last publish

Collaborators

  • avatar