Type Alias Server

type Server = {
    createServer(serverData: ServerSkeleton): Promise<ServerSkeleton>;
    createServerExportTemplate(): ServerExportInterface;
    exportServer(
        serverId: string,
        options: ServerExportOptions,
    ): Promise<ServerExportInterface>;
    exportServerByUrl(
        serverUrl: string,
        options: ServerExportOptions,
    ): Promise<ServerExportInterface>;
    exportServers(options: ServerExportOptions): Promise<ServerExportInterface>;
    importFirstServer(
        importData: ServerExportInterface,
        options: ServerImportOptions,
    ): Promise<ServerExportInterface>;
    importServers(
        importData: ServerExportInterface,
        options: ServerImportOptions,
        serverId?: string,
        serverUrl?: string,
    ): Promise<ServerExportInterface>;
    readServer(serverId: string): Promise<ServerSkeleton>;
    readServerByUrl(serverUrl: string): Promise<ServerSkeleton>;
    readServers(): Promise<ServerSkeleton[]>;
}

Index

Methods

createServer createServerExportTemplate exportServer exportServerByUrl exportServers importFirstServer importServers readServer readServerByUrl readServers

Methods

createServer

createServer(serverData: ServerSkeleton): Promise<ServerSkeleton>
Creates a server
Parameters
- serverData: ServerSkeleton
  server object
Returns Promise<ServerSkeleton>
a promise that resolves to a server object
- Defined in ops/classic/ServerOps.ts:77

createServerExportTemplate

createServerExportTemplate(): ServerExportInterface
Create an empty server export template

Returns ServerExportInterface
an empty server export template
- Defined in ops/classic/ServerOps.ts:28

exportServer

exportServer(
serverId: string,
options: ServerExportOptions,
): Promise<ServerExportInterface>
Export a single server by id. The response can be saved to file as is.
Parameters
- serverId: string
  Server id
- options: ServerExportOptions
  Server export options
Returns Promise<ServerExportInterface>
Promise resolving to a ServerExportInterface object.
- Defined in ops/classic/ServerOps.ts:52

exportServerByUrl

exportServerByUrl(
serverUrl: string,
options: ServerExportOptions,
): Promise<ServerExportInterface>
Export a single server by url. The response can be saved to file as is.
Parameters
- serverUrl: string
  Server url
- options: ServerExportOptions
  Server export options
Returns Promise<ServerExportInterface>
Promise resolving to a ServerExportInterface object.
- Defined in ops/classic/ServerOps.ts:62

exportServers

exportServers(options: ServerExportOptions): Promise<ServerExportInterface>
Export all servers. The response can be saved to file as is.
Parameters
- options: ServerExportOptions
  Server export options
Returns Promise<ServerExportInterface>
Promise resolving to a ServerExportInterface object.
- Defined in ops/classic/ServerOps.ts:71

importFirstServer

importFirstServer(
importData: ServerExportInterface,
options: ServerImportOptions,
): Promise<ServerExportInterface>
Imports the first server from the importData
Parameters
- importData: ServerExportInterface
  server import data
- options: ServerImportOptions
  server import options
Returns Promise<ServerExportInterface>
- Defined in ops/classic/ServerOps.ts:83

importServers

importServers(
    importData: ServerExportInterface,
    options: ServerImportOptions,
    serverId?: string,
    serverUrl?: string,
): Promise<ServerExportInterface>
Imports servers along with their properties
Parameters
- importData: ServerExportInterface
  server import data
- options: ServerImportOptions
  server import options
- OptionalserverId: string
  Optional server id. If supplied, only the server (and its properties) of that id is imported. Takes priority over serverUrl if both are provided.
- OptionalserverUrl: string
  Optional server url. If supplied, only the server of that url is imported.
Returns Promise<ServerExportInterface>
a promise that resolves to a server export object
- Defined in ops/classic/ServerOps.ts:95

readServer

readServer(serverId: string): Promise<ServerSkeleton>
Read server by id
Parameters
- serverId: string
  Server id
Returns Promise<ServerSkeleton>
a promise that resolves to a server object
- Defined in ops/classic/ServerOps.ts:34

readServerByUrl

readServerByUrl(serverUrl: string): Promise<ServerSkeleton>
Read server by url
Parameters
- serverUrl: string
  Server url
Returns Promise<ServerSkeleton>
a promise that resolves to a server object
- Defined in ops/classic/ServerOps.ts:40

readServers

readServers(): Promise<ServerSkeleton[]>
Read all servers.

Returns Promise<ServerSkeleton[]>
a promise that resolves to an array of server objects
- Defined in ops/classic/ServerOps.ts:45

Type Alias Server

Index

Methods

Methods

createServer

Parameters

Returns Promise<ServerSkeleton>

createServerExportTemplate

Returns ServerExportInterface

exportServer

Parameters

Returns Promise<ServerExportInterface>

exportServerByUrl

Parameters

Returns Promise<ServerExportInterface>

exportServers

Parameters

Returns Promise<ServerExportInterface>

importFirstServer

Parameters

Returns Promise<ServerExportInterface>

importServers

Parameters

Returns Promise<ServerExportInterface>

readServer

Parameters

Returns Promise<ServerSkeleton>

readServerByUrl

Parameters

Returns Promise<ServerSkeleton>

readServers

Returns Promise<ServerSkeleton[]>

Settings

On This Page