Minehut-apis NPM

Installation

npm install minehut-apis
# or
yarn add minehut-apis
# or
pnpm add minehut-apis

Loading the module

ES Modules (ESM)

import { Client } from "minehut-apis";

CommonJS

const { Client } = require("minehut-apis");

Example usage

Get server by name

import { Client } from "minehut-apis";

const minehut = new Client();

(async () => {
  // Get server by name
  const server = await minehut.server.get("lightskies", true);
  
  console.log(server);
})();

Get server by Id

import { Client } from "minehut-apis";

const minehut = new Client();

(async () => {
  // Get server by Id
  const server = await minehut.server.get("60e57b624cba54007bf05c34", false);

  console.log(server);
})();

Get product by name

import { Client } from "minehut-apis";

const minehut = new Client();

(async () => {
  // Get product by name
  const product = await client.product.get("WorldEdit", true);

  console.log(product);

  // The publisher of the product
  console.log(`Publisher: ${product.publisherName}`);
  // The short description of the product
  console.log(`Short description: ${product.shortDescription}`);
})();

Avoid conflicts

Importing another module with the same name will cause conflicts (eg. discord.js). This can simply be avoided by renaming the import.

import { Client as Minehut } from "minehut-apis";
// Using CommonJS: "const { Client: Minehut } = require("minehut-apis")"
import { Client } from "discord.js";

// minehut-apis client
const minehut = new Minehut();

// discord.js client
const client = new Client();