Skip to main content
Module

x/hypixel/index.ts>DefaultMeta

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 DefaultMeta
import { type DefaultMeta } from "https://deno.land/x/hypixel@v3.1.1/index.ts";

Possible meta options returned on the meta variable.

Properties

optional
ratelimit: RateLimitData

If this request required an API key it returned rate limit information in the headers, which is included here.

optional
cached: boolean

If you included a cache get/set method in the options, this value will be set to true if that cache was hit.

optional
cloudflareCache: { status:
| "HIT"
| "MISS"
| "BYPASS"
| "EXPIRED"
| "DYNAMIC"
; age?: number; maxAge?: number; }

Data from CloudFlare's headers in regards to caching - particularly relevant for resources endpoints.