Name

Instance

Description

Basic information about an instance.

Param: region

Region of the instance.

Param: cors_allowed

Is CORS allowed?

Param: api_allowed

Is API allowed?

Param: type

Type of the instance.

Param: url

URL of the instance.

Param: health

Instance uptime.

Constructors

  • Parameters

    • region: string
    • cors_allowed: boolean
    • api_allowed: boolean
    • type: InstanceTypes
    • url: string
    • Optional health: number

    Returns Instance

Properties

api_allowed: boolean
cors_allowed: boolean
health?: number
region: string
url: string

Methods

  • Returns Promise<InstanceStats>

    Instance stats object.

    Name

    fetchStats

    Description

    Fetches stats of an instance.

    Example

    await instance.fetchStats();
    

Generated using TypeDoc