XFarr API Wrapper

Common errors

• Error: Unauthorized

  cause The provided API key is invalid, expired, or missing in the request.
  fix Ensure you are using a correct and active API key. Double-check for typos and confirm it has not expired on the xfarr.com dashboard. Pass the key to the `APIWrapper` constructor: `new APIWrapper('YOUR_API_KEY')`.

• xfar.[feature].[name] is not a function

  cause Attempting to call a non-existent feature or method, or the API feature may have been removed or renamed.
  fix Consult the latest `xfarr-api` documentation or the `api.xfarr.com` documentation to verify the correct feature and method names. Ensure you are using a supported version of the library.

• TypeError: APIWrapper is not a constructor

  cause The `APIWrapper` class was not instantiated with the `new` keyword.
  fix Always create an instance of the wrapper using `new APIWrapper(apiKey);` before attempting to call its methods.

Warnings

• gotcha An API key is strictly required for all interactions with the xfarr.com API. Operations will fail without a valid key.
  Fix: Obtain an API key from https://api.xfarr.com/auth/signin and pass it during `APIWrapper` instantiation, or set it as an environment variable (e.g., `XFARR_API_KEY`).
• gotcha The underlying xfarr.com API may have rate limits or usage quotas. Exceeding these limits can lead to temporary or permanent blocking of your API key.
  Fix: Refer to the official API documentation at https://api.xfarr.com/ for rate limit specifics. Implement exponential backoff or caching mechanisms in your application to manage request frequency.
• gotcha As a wrapper around a third-party API, `xfarr-api`'s functionality is dependent on the stability and feature set of `api.xfarr.com`. Changes to the upstream API could introduce breaking changes not reflected in the `xfarr-api`'s major version bumps.
  Fix: Monitor the `xfarr-api` GitHub repository and the `api.xfarr.com` service announcements for updates. Thoroughly test your application after updating `xfarr-api` or if you observe unexpected API behavior.

Install

• npm install xfarr-api npm
• yarn add xfarr-api yarn
• pnpm add xfarr-api pnpm

Imports

• APIWrapper
  wrong:

  import { APIWrapper } from 'xfarr-api';

  correct:

  import APIWrapper from 'xfarr-api';

  Main class/function, imported as a default export in ECMAScript Modules (ESM).
• APIWrapper
  wrong:

  const { APIWrapper } = require('xfarr-api');

  correct:

  const APIWrapper = require('xfarr-api');

  Main class/function, imported via CommonJS `require`. The package exports a default/module.exports value.
• APIWrapperType
  wrong:

  import { APIWrapperType } from 'xfarr-api';

  correct:

  import type { APIWrapperType } from 'xfarr-api';

  Type import for TypeScript users to ensure correct type inference for the `APIWrapper` class or instance. Assumes types are exported alongside the main module.

Quickstart

Demonstrates initializing the API wrapper with an API key and making two example API calls using the promise-based interface.

import APIWrapper from 'xfarr-api';

const API_KEY = process.env.XFARR_API_KEY ?? ''; // Ensure your API key is set as an environment variable

if (!API_KEY) {
  console.error('Error: XFARR_API_KEY environment variable is not set.');
  process.exit(1);
}

const xfar = new APIWrapper(API_KEY);

// Example of an API call: fetching npm package information
xfar.stalking.npmjs("xfarr-api")
  .then(response => {
    console.log('NPM Stalking Result:', response);
  })
  .catch(error => {
    console.error('Error during NPM stalking:', error.message);
  });

// Another example: (assuming 'random' feature exists and takes no params)
xfar.random.meme()
  .then(response => {
    console.log('Random Meme:', response);
  })
  .catch(error => {
    console.error('Error fetching random meme:', error.message);
  });