nookipedia-api

Simple JS wrapper for the Nookipedia API

Click here for documentation of the latest version of the Nookipedia API

Installation

With npm:

$ npm install nookipedia-api

With Yarn:

$ yarn add nookipedia-api

Usage

Install the package and then import it into your project:

import { NookipediaApi } from 'nookipedia-api';

Create a NookipediaApi object with your API key:

const nookipedia = new NookipediaApi('<api-key>');

Make a request with the new object:

const bugs = await nookipedia.getAllBugs();
console.log(bugs);

/*
  Output:
  [
    {
      name: 'agrias butterfly',
      url: 'https://nookipedia.com/wiki/Agrias_butterfly',
      number: '10',
      image_url: 'https://dodo.ac/np/images/6/60/Agrias_Butterfly_NH_Icon.png',
      ...
    },
    ...
  ]
*/

Error Handling

It's important to handle any errors (E.g. 404):

try {
  const bug = await nookipedia.getBug('fish');
} catch (error) {
  console.error(error);
}

Get more information from your errors with instanceof:

try {
  const bug = await nookipedia.getBug('fish');
} catch (error) {
  if (error instanceof NookipediaError) {
    console.error(error.body.title);
    console.error(error.body.details);
  }
}

Options

Pass options with query params or fetch options:

const controller = new AbortController();
const bugs = await nookipedia.getBug('agrias butterfly', {
  query: {
    thumbsize: 200
  },
  fetchOptions: {
    signal: controller.signal
  }
});
console.log(bugs);

/*
  Output:
  [
    {
      name: 'agrias butterfly',
      url: 'https://nookipedia.com/wiki/Agrias_butterfly',
      number: '10',
      image_url: 'https://dodo.ac/np/images/6/60/Agrias_Butterfly_NH_Icon.png',
      render_url: 'https://dodo.ac/np/images/thumb/d/db/Agrias_Butterfly_NH.png/200px-Agrias_Butterfly_NH.png',
      ...
    },
    ...
  ]
*/