Skip to main content
Home
Browse packagesDocsSign in

@minecraft/minecraftstatuspinger@1.2.1
Built and signed on GitHub Actions

latest
woodendoors7/MinecraftStatusPinger

🟩 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
a month 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>

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

npx jsr add @minecraft/minecraftstatuspinger

Import symbol

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

Add Package

yarn dlx jsr add @minecraft/minecraftstatuspinger

Import symbol

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

Add Package

pnpm dlx 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";