Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ClientServer

Index

Constructors

Properties

backups: BackupManager
client: PteroClient
description: undefined | string

The description of the server (if set).

dockerImage: string

The docker image the server uses.

eggFeatures: undefined | string[]

A list of egg features the server uses.

featureLimits: FeatureLimits

An object containing the server feature limits.

identifier: string

A substring of the server's UUID.

installing: boolean

Whether the server is installing.

internalId: number

The internal ID of the server.

invocation: null | string

The invocation (or startup command) for the server.

isOwner: boolean

Whether the client user is the server owner.

limits: Limits

An object containing the server limits.

name: string

The name of the server.

node: string

The name of the node the server is on.

sftpDetails: { ip: string; port: number }

An object containing the SFTP details.

Type declaration

  • ip: string
  • port: number
status: undefined | string

The current status of the server.

suspended: boolean

Whether the server is suspended.

transferring: boolean

Whether the server is transferring.

uuid: string

The UUID of the server.

Accessors

  • get panelURL(): string

Methods

  • _patch(data: any): void
  • reinstall(): Promise<void>
  • rename(name: string): Promise<void>
  • sendCommand(command: string): Promise<void>
  • setDockerImage(image: string): Promise<void>
  • setPowerState(state: "start" | "stop" | "restart" | "kill"): Promise<void>
  • Sets the power state of the server.

    Parameters

    • state: "start" | "stop" | "restart" | "kill"

      The power state.

    Returns Promise<void>

  • setVariable(key: string, value: string): Promise<EggVariable>
  • Updates a specified environment variable on the server. The key must be the environment variable name in capital letters, not the normal variable name.

    Parameters

    • key: string

      The environment variable key.

    • value: string

      The value of the environment variable.

    Returns Promise<EggVariable>

    The updated egg variable.

  • toJSON(): object
  • toString(): string

Generated using TypeDoc