Class Server

constructor

• new Server(userClient, server): Server

• Parameters

  • userClient: UserClient
  • server: RawServer

  Returns Server

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

Optionalsubusers

Readonlyuuid

Optionalvariables

compressFiles

• compressFiles(dir, files): Promise<File>

• Compress files in a specific directory

  Parameters

  • dir: string
  • files: (string | File)[]

  Returns Promise<File>

createAllocation

• createAllocation(): Promise<Allocation>

• Create a new allocation for this server

  Returns Promise<Allocation>

createBackup

• createBackup(builder): Promise<Backup>

• Create a new backup

  Parameters

  • builder: BackupBuilder

  Returns Promise<Backup>

createDatabases

• createDatabases(builder): Promise<Database>

• Create a databases for this server

  Parameters

  • builder: DatabaseBuilder

  Returns Promise<Database>

createFolder

• createFolder(dir, folderName): Promise<void>

• Create a folder in a specific directory

  Parameters

  • dir: string
  • folderName: string

  Returns Promise<void>

createSchedule

• createSchedule(builder): Promise<Schedule>

• Create a new schedule

  Parameters

  • builder: ScheduleBuilder

  Returns Promise<Schedule>

createSubuser

• createSubuser(builder): Promise<SubUser>

• Create a new subuser

  Parameters

  • builder: SubUserBuilder

  Returns Promise<SubUser>

decompressFile

• decompressFile(dir, file): Promise<void>

• Decompress a archive

  Parameters

  • dir: string
  • file: string | File

  Returns Promise<void>

deleteFiles

• deleteFiles(dir, files): Promise<void>

• Delete files in a specific directory

  Parameters

  • dir: string
  • files: (string | File)[]

  Returns Promise<void>

getAllocations

• getAllocations(): Promise<Allocation[]>

• Get all allocation assigned to this server

  Returns Promise<Allocation[]>

getBackup

• getBackup(uuid): Promise<Backup>

• Get a backup of this server

  Parameters

  • uuid: string

  Returns Promise<Backup>

getBackups

• getBackups(): Promise<Backup[]>

• Get all backups of this server

  Returns Promise<Backup[]>

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>

getDatabases

• getDatabases(): Promise<Database[]>

• Get the databases of this server

  Returns Promise<Database[]>

getFiles

• getFiles(dir?): Promise<File[]>

• Gets the files of a specific directory

  Parameters

  • dir: string = '/'

  Returns Promise<File[]>

getSchedule

• getSchedule(id): Promise<Schedule>

• Get the schedules of this server

  Parameters

  • id: number

  Returns Promise<Schedule>

getSchedules

• getSchedules(): Promise<Schedule[]>

• Get the schedules of this server

  Returns Promise<Schedule[]>

getSubuser

• getSubuser(uuid): Promise<SubUser>

• Get a subuser of this server

  Parameters

  • uuid: string

  Returns Promise<SubUser>

getSubusers

• getSubusers(): Promise<SubUser[]>

• Get all subusers of this server

  Returns Promise<SubUser[]>

getUsage

• getUsage(): Promise<StatsAttributes>

• Get the server resource usage

  Returns Promise<StatsAttributes>

getVariables

• getVariables(): Promise<Variable[]>

• Get the variables of this server

  Returns Promise<Variable[]>

kill

• kill(): Promise<void>

• Kill this server WARNING: This might cause data loss!

  Returns Promise<void>

reinstall

• reinstall(): Promise<void>

• Reinstall this server

  Returns Promise<void>

renameFiles

• renameFiles(dir, files): Promise<void>

• Rename files in a specific directory

  Parameters

  • dir: string
  • files: {
        from: string | File;
        to: string;
    }[]

  Returns Promise<void>

restart

• restart(): Promise<void>

• Restart this server

  Returns Promise<void>

sendCommand

• sendCommand(command): Promise<void>

• Send a console command to this server

  Parameters

  • command: string

  Returns Promise<void>

setDescription

• setDescription(description): Promise<void>

• Set the description for this server

  Parameters

  • description: string

  Returns Promise<void>

setDockerImage

• setDockerImage(image): Promise<void>

• Set the docker image for this server

  Parameters

  • image: string

  Returns Promise<void>

setName

• setName(name): Promise<void>

• Set the name for this server

  Parameters

  • name: string

  Returns Promise<void>

start

• start(): Promise<void>

• Start this server

  Returns Promise<void>

stop

• stop(): Promise<void>

• Stop this server

  Returns Promise<void>

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

uploadUrl

• uploadUrl(): Promise<URL>

• Get a upload url to upload files

  Returns Promise<URL>