Class Server

Implements

ServerAttributes

Constructors

constructor

new Server(userClient, server): Server
Parameters
- userClient: UserClient
- server: RawServer
Returns Server
- Defined in src/UserClient/Server.ts:79

Properties

`Optional`allocations

allocations?: Allocation[]

description

description: string

docker_image

docker_image: string

`Optional`egg

egg?: RawEgg

`Readonly`egg_features

egg_features: string[]

`Readonly`feature_limits

feature_limits: {
    allocations: number;
    backups: number;
    databases: number;
}

`Readonly`identifier

identifier: string

`Readonly`internal_id

internal_id: string | number

`Readonly`invocation

invocation: string

`Readonly`is_installing

is_installing: boolean

`Readonly`is_node_under_maintenance

is_node_under_maintenance: boolean

`Readonly`is_suspended

is_suspended: boolean

`Readonly`is_transferring

is_transferring: boolean

`Readonly`limits

limits: {
    cpu: number;
    disk: number;
    io: number;
    memory: number;
    oom_disabled: boolean;
    swap: number;
    threads?: null | string;
}

name

name: string

`Readonly`node

node: string

`Readonly`server_owner

server_owner: boolean

`Readonly`sftp_details

sftp_details: {
ip: string;
port: number;
}

status

Deprecated

Use getStatus() or getUsage() instead, as the panel will always return null as status

`Optional`subusers

subusers?: SubUser[]

`Readonly`uuid

uuid: string

`Optional`variables

variables?: Variable[]

Methods

compressFiles

compressFiles(dir, files): Promise<File>
Compress files in a specific directory
Parameters
- dir: string
- files: (string | File)[]
Returns Promise<File>
- Defined in src/UserClient/Server.ts:247

createAllocation

createAllocation(): Promise<Allocation>
Create a new allocation for this server

Returns Promise<Allocation>
- Defined in src/UserClient/Server.ts:371

createBackup

createBackup(builder): Promise<Backup>
Create a new backup
Parameters
- builder: BackupBuilder
Returns Promise<Backup>
- Defined in src/UserClient/Server.ts:438

createDatabases

createDatabases(builder): Promise<Database>
Create a databases for this server
Parameters
- builder: DatabaseBuilder
Returns Promise<Database>
- Defined in src/UserClient/Server.ts:203

createFolder

createFolder(dir, folderName): Promise<void>
Create a folder in a specific directory
Parameters
- dir: string
- folderName: string
Returns Promise<void>
- Defined in src/UserClient/Server.ts:290

createSchedule

createSchedule(builder): Promise<Schedule>
Create a new schedule
Parameters
- builder: ScheduleBuilder
Returns Promise<Schedule>
- Defined in src/UserClient/Server.ts:345

createSubuser

createSubuser(builder): Promise<SubUser>
Create a new subuser
Parameters
- builder: SubUserBuilder
Returns Promise<SubUser>
- Defined in src/UserClient/Server.ts:404

decompressFile

decompressFile(dir, file): Promise<void>
Decompress a archive
Parameters
- dir: string
- file: string | File
Returns Promise<void>
- Defined in src/UserClient/Server.ts:265

deleteFiles

deleteFiles(dir, files): Promise<void>
Delete files in a specific directory
Parameters
- dir: string
- files: (string | File)[]
Returns Promise<void>
- Defined in src/UserClient/Server.ts:277

getAllocations

getAllocations(): Promise<Allocation[]>
Get all allocation assigned to this server

Returns Promise<Allocation[]>
- Defined in src/UserClient/Server.ts:361

getBackup

getBackup(uuid): Promise<Backup>
Get a backup of this server
Parameters
- uuid: string
Returns Promise<Backup>
- Defined in src/UserClient/Server.ts:430

getBackups

getBackups(): Promise<Backup[]>
Get all backups of this server

Returns Promise<Backup[]>
- Defined in src/UserClient/Server.ts:420

getConsoleSocket

getConsoleSocket(prettyLogs?): Promise<ServerConsoleConnection>
Get a console socket and automatically connects to it
Parameters
- prettyLogs: boolean = true
  Should the text NOT include color coding. This will make the logs better readable.
Returns Promise<ServerConsoleConnection>
- Defined in src/UserClient/Server.ts:111

getDatabases

getDatabases(): Promise<Database[]>
Get the databases of this server

Returns Promise<Database[]>
- Defined in src/UserClient/Server.ts:193

getFiles

getFiles(dir?): Promise<File[]>
Gets the files of a specific directory
Parameters
- dir: string = '/'
Returns Promise<File[]>
- Defined in src/UserClient/Server.ts:219

getSchedule

getSchedule(id): Promise<Schedule>
Get the schedules of this server
Parameters
- id: number
Returns Promise<Schedule>
- Defined in src/UserClient/Server.ts:337

getSchedules

getSchedules(): Promise<Schedule[]>
Get the schedules of this server

Returns Promise<Schedule[]>
- Defined in src/UserClient/Server.ts:327

getStatus

getStatus(): Promise<ServerStatus>
Get the status of this server

Returns Promise<ServerStatus>
- Defined in src/UserClient/Server.ts:118

getSubuser

getSubuser(uuid): Promise<SubUser>
Get a subuser of this server
Parameters
- uuid: string
Returns Promise<SubUser>
- Defined in src/UserClient/Server.ts:396

getSubusers

getSubusers(): Promise<SubUser[]>
Get all subusers of this server

Returns Promise<SubUser[]>
- Defined in src/UserClient/Server.ts:386

getUsage

getUsage(): Promise<StatsAttributes>
Get the server resource usage

Returns Promise<StatsAttributes>
- Defined in src/UserClient/Server.ts:125

getVariables

getVariables(): Promise<Variable[]>
Get the variables of this server

Returns Promise<Variable[]>
- Defined in src/UserClient/Server.ts:454

kill

kill(): Promise<void>
Kill this server WARNING: This might cause data loss!

Returns Promise<void>
- Defined in src/UserClient/Server.ts:181

reinstall

reinstall(): Promise<void>
Reinstall this server

Returns Promise<void>
- Defined in src/UserClient/Server.ts:511

renameFiles

renameFiles(dir, files): Promise<void>
Rename files in a specific directory
Parameters
- dir: string
- files: {
  from: string | File;
  to: string;
  }[]
Returns Promise<void>
- Defined in src/UserClient/Server.ts:229

restart

restart(): Promise<void>
Restart this server

Returns Promise<void>
- Defined in src/UserClient/Server.ts:168

sendCommand

sendCommand(command): Promise<void>
Send a console command to this server
Parameters
- command: string
Returns Promise<void>
- Defined in src/UserClient/Server.ts:132

setDescription

setDescription(description): Promise<void>
Set the description for this server
Parameters
- description: string
Returns Promise<void>
- Defined in src/UserClient/Server.ts:494

setDockerImage

setDockerImage(image): Promise<void>
Set the docker image for this server
Parameters
- image: string
Returns Promise<void>
- Defined in src/UserClient/Server.ts:464

setName

setName(name): Promise<void>
Set the name for this server
Parameters
- name: string
Returns Promise<void>
- Defined in src/UserClient/Server.ts:477

start

start(): Promise<void>
Start this server

Returns Promise<void>
- Defined in src/UserClient/Server.ts:144

stop

stop(): Promise<void>
Stop this server

Returns Promise<void>
- Defined in src/UserClient/Server.ts:156

uploadFile

uploadFile(dir?, file, filename): Promise<void>
Upload a file
Parameters
- dir: string = '/'
- file: string | Buffer | Blob
- filename: string
Returns Promise<void>
File
A buffer, blob or the path to the file
- Defined in src/UserClient/Server.ts:311

uploadUrl

uploadUrl(): Promise<URL>
Get a upload url to upload files

Returns Promise<URL>
- Defined in src/UserClient/Server.ts:302

Class Server

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Server

Properties

Optionalallocations

description

docker_image

Optionalegg

Readonlyegg_features

Readonlyfeature_limits

Readonlyidentifier

Readonlyinternal_id

Readonlyinvocation

Readonlyis_installing

Readonlyis_node_under_maintenance

Readonlyis_suspended

Readonlyis_transferring

Readonlylimits

name

Readonlynode

Readonlyserver_owner

Readonlysftp_details

status

Deprecated

Optionalsubusers

Readonlyuuid

Optionalvariables

Methods

compressFiles

Parameters

Returns Promise<File>

createAllocation

Returns Promise<Allocation>

createBackup

Parameters

Returns Promise<Backup>

createDatabases

Parameters

Returns Promise<Database>

createFolder

Parameters

Returns Promise<void>

createSchedule

Parameters

Returns Promise<Schedule>

createSubuser

Parameters

Returns Promise<SubUser>

decompressFile

Parameters

Returns Promise<void>

deleteFiles

Parameters

Returns Promise<void>

getAllocations

Returns Promise<Allocation[]>

getBackup

Parameters

Returns Promise<Backup>

getBackups

Returns Promise<Backup[]>

getConsoleSocket

Parameters

Returns Promise<ServerConsoleConnection>

getDatabases

Returns Promise<Database[]>

getFiles

Parameters

Returns Promise<File[]>

getSchedule

Parameters

Returns Promise<Schedule>

getSchedules

`Optional`allocations

`Optional`egg

`Readonly`egg_features

`Readonly`feature_limits

`Readonly`identifier

`Readonly`internal_id

`Readonly`invocation

`Readonly`is_installing

`Readonly`is_node_under_maintenance

`Readonly`is_suspended

`Readonly`is_transferring

`Readonly`limits

`Readonly`node

`Readonly`server_owner

`Readonly`sftp_details

`Optional`subusers

`Readonly`uuid

`Optional`variables