Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

Hierarchy

  • IOptions

Implemented by

Index

Properties

Properties

Optional cloudProxy

cloudProxy?: { cookies?: { domain?: string; expires?: number; httpOnly?: boolean; name: string; path?: string; sameSite?: "Strict" | "Lax"; secure?: boolean; url?: string; value: string }[]; headers?: Record<string, any>; maxTimeout?: number; session?: string }

CloudProxy options for requests NameMC often uses CloudFlare to protect against DDoS attacks If you want the library to work at such times, you need to deploy your own Cloud Proxy instance

example
new NameMC({
    proxy: "http://192.168.1.51:25565/v1" // CloudProxy URL
    cloudProxy: {}
    // CloudProxy options.
    // Optional.
    // To enable CloudProxy support, you cannot delete an object!
});
see

CloudProxy

see

CloudProxy Request Get options description

Type declaration

  • Optional cookies?: { domain?: string; expires?: number; httpOnly?: boolean; name: string; path?: string; sameSite?: "Strict" | "Lax"; secure?: boolean; url?: string; value: string }[]

    Cookies for requests

  • Optional headers?: Record<string, any>

    Headers for requests

  • Optional maxTimeout?: number

    Max request timeout

  • Optional session?: string

    Session ID

Optional defaultSkinsModel

defaultSkinsModel?: CLASSIC | SLIM | "classic" | "slim"

Model for skins by default, if an error occurred while trying to parse it

Optional proxy

proxy?: string

Proxy url for requests Support CloudProxy

Optional rendersIgnoreProxy

rendersIgnoreProxy?: boolean

Ignore proxy url for renders

Generated using TypeDoc