Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/hypixel/index.ts>ClientOptions

With thorough IntelliSense support & 100% test coverage, this is an unopinionated async/await API wrapper for Hypixel's Public API. It is developed in TypeScript complete with documentation, typed interfaces for all API responses (and an OpenAPI 3.0 schema!), built-in rate-limit handling, flexible cache support, helper functions, and support for undocumented endpoints.
zikeji/node-hypixel
Latest
interface ClientOptions
import { type ClientOptions } from "https://deno.land/x/hypixel@v3.1.1/index.ts";

Properties

optional
retries: number

Amount of times to retry a failed request.

optional
timeout: number

The time, in milliseconds, you want to wait before giving up on the method call.

NOTE: This option is ignored when being used in Deno.

optional
userAgent: string

User agent the client uses when making calls to Hypixel's API

optional
cache: BasicCache

Functions you want to use for caching results. Optional.