Skip to main content
Home
This release is 1 version behind 1.2.2 — the latest version of @minecraft/minecraftstatuspinger. Jump to latest

Built and signed on GitHub Actions

🟩 A modern, small, fast, performant, zero dependency TypeScript library made for pinging and getting status of Minecraft servers.

This package works with Cloudflare Workers, Node.js, Deno, Bun
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
JSR Score
100%
Published
11 months ago (1.2.1)
function lookup
lookup(options?: ServerStatusOptions): Promise<ServerStatus>

Looks up the server.

Examples

Here's a simple example:

let result = await mc.lookup({
   host: "mc.hypixel.net"
   port: 25565,
   timeout: 10000,
   ping: true,
   protocolVersion: 767
   throwOnParseError: false,
   SRVLookup: true,
   JSONParse: true
})

Parameters

optional
options: ServerStatusOptions

Return Type

Promise<ServerStatus>

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@minecraft/minecraftstatuspinger

Import symbol

import { lookup } from "@minecraft/minecraftstatuspinger";
or

Import directly with a jsr specifier

import { lookup } from "jsr:@minecraft/minecraftstatuspinger";

Add Package

pnpm i jsr:@minecraft/minecraftstatuspinger
or (using pnpm 10.8 or older)
pnpm dlx jsr add @minecraft/minecraftstatuspinger

Import symbol

import { lookup } from "@minecraft/minecraftstatuspinger";

Add Package

yarn add jsr:@minecraft/minecraftstatuspinger
or (using Yarn 4.8 or older)
yarn dlx jsr add @minecraft/minecraftstatuspinger

Import symbol

import { lookup } from "@minecraft/minecraftstatuspinger";

Add Package

vlt install jsr:@minecraft/minecraftstatuspinger

Import symbol

import { lookup } from "@minecraft/minecraftstatuspinger";

Add Package

npx jsr add @minecraft/minecraftstatuspinger

Import symbol

import { lookup } from "@minecraft/minecraftstatuspinger";

Add Package

bunx jsr add @minecraft/minecraftstatuspinger

Import symbol

import { lookup } from "@minecraft/minecraftstatuspinger";