Class ServerBuilder

Hierarchy

Builder
- ServerBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new ServerBuilder(): ServerBuilder

Overrides Builder.constructor
- Defined in src/builders/Server.ts:31
Returns ServerBuilder

Methods

build

build(): CreateServerOptions

Overrides Builder.build
- Defined in src/builders/Server.ts:164
Returns CreateServerOptions

setAllocation

setAllocation(options: { additional?: number[]; default?: number }): ServerBuilder

- Defined in src/builders/Server.ts:128
Parameters
- options: { additional?: number[]; default?: number }
  - Optional additional?: number[]
  - Optional default?: number
Returns ServerBuilder

setDeployment

setDeployment(options: { dedicatedIp?: boolean; locations?: number[]; portRange?: string[] }): ServerBuilder

- Defined in src/builders/Server.ts:138
Parameters
- options: { dedicatedIp?: boolean; locations?: number[]; portRange?: string[] }
  - Optional dedicatedIp?: boolean
  - Optional locations?: number[]
  - Optional portRange?: string[]
Returns ServerBuilder

setDescription

setDescription(description: string): ServerBuilder

- Defined in src/builders/Server.ts:66
Parameters
- description: string
Returns ServerBuilder

setDockerImage

setDockerImage(image: string): ServerBuilder

- Defined in src/builders/Server.ts:88
Parameters
- image: string
Returns ServerBuilder

setEgg

setEgg(egg: number | Egg): ServerBuilder

- Defined in src/builders/Server.ts:76
Parameters
- egg: number | Egg
Returns ServerBuilder

setEnvironment

setEnvironment(variables: Record<string, string | number | boolean>): ServerBuilder

- Defined in src/builders/Server.ts:103
Parameters
- variables: Record<string, string | number | boolean>
Returns ServerBuilder

setExternalId

setExternalId(id: undefined | string): ServerBuilder

- Defined in src/builders/Server.ts:56
Parameters
- id: undefined | string
Returns ServerBuilder

setFeatureLimits

setFeatureLimits(featureLimits: Partial<FeatureLimits>): ServerBuilder

- Defined in src/builders/Server.ts:123
Parameters
- featureLimits: Partial<FeatureLimits>
Returns ServerBuilder

setLimits

setLimits(limits: Partial<Limits>): ServerBuilder

- Defined in src/builders/Server.ts:118
Parameters
- limits: Partial<Limits>
Returns ServerBuilder

setName

setName(name: string): ServerBuilder

- Defined in src/builders/Server.ts:61
Parameters
- name: string
Returns ServerBuilder

setOOMDisabled

setOOMDisabled(value: boolean): ServerBuilder

- Defined in src/builders/Server.ts:113
Parameters
- value: boolean
Returns ServerBuilder

setSkipScripts

setSkipScripts(value: boolean): ServerBuilder

- Defined in src/builders/Server.ts:108
Parameters
- value: boolean
Returns ServerBuilder

setStartOnCompletion

setStartOnCompletion(value: boolean): ServerBuilder

- Defined in src/builders/Server.ts:159
Parameters
- value: boolean
Returns ServerBuilder

setStartup

setStartup(command: string): ServerBuilder

- Defined in src/builders/Server.ts:93
Parameters
- command: string
Returns ServerBuilder

setUser

setUser(user: number | User): ServerBuilder

- Defined in src/builders/Server.ts:71
Parameters
- user: number | User
Returns ServerBuilder

setVariable

setVariable(key: string, value: string | number | boolean): ServerBuilder

- Defined in src/builders/Server.ts:98
Parameters
- key: string
- value: string | number | boolean
Returns ServerBuilder

Generated using TypeDoc