@zikeji/hypixel / DefaultMeta

Interface: DefaultMeta

Possible meta options returned on the meta variable.

Properties

cached?

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.

---

cloudflareCache?

optional cloudflareCache: object

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

age?

optional age: number

Cloudflare cache age.

maxAge?

optional maxAge: number

Cloudflare max cache age.

status

status: "HIT" | "MISS" | "BYPASS" | "EXPIRED" | "DYNAMIC"

Cloudflare cache status.

---

ratelimit?

optional ratelimit: RateLimitData

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