Satisfactory Server SDK

Appearance

Satisfactory Server SDK / SatisfactoryServer

Class: SatisfactoryServer ​

Constructors ​

new SatisfactoryServer() ​

new SatisfactoryServer(baseUrl, options?): SatisfactoryServer

Parameters ​

• baseUrl: string

• options?: SatisfactoryServerOptions

Returns ​

SatisfactoryServer

Defined in ​

src/index.ts:58

Properties ​

baseUrl ​

protected baseUrl: string

Defined in ​

src/index.ts:53

bearerToken ​

protected bearerToken: undefined | string

Defined in ​

src/index.ts:56

client ​

client: IHttpClient

Defined in ​

src/index.ts:54

Methods ​

execute() ​

execute(apiFunction, data) ​

execute(apiFunction, data?): Promise<object>

Parameters ​

• apiFunction: "getadvancedgamesettings"

• data?: undefined

Returns ​

Promise<object>

data ​

data: GetAdvancedGameSettingsResponseBody

Defined in ​

src/index.ts:79

execute(apiFunction, data) ​

execute(apiFunction, data?): Promise<object>

Parameters ​

• apiFunction: "getserveroptions"

• data?: undefined

Returns ​

Promise<object>

data ​

data: GetServerOptionsResponseBody

Defined in ​

src/index.ts:83

execute(apiFunction, data) ​

execute(apiFunction, data?): Promise<object>

Parameters ​

• apiFunction: "healthcheck"

• data?: HealthCheckRequestData

Returns ​

Promise<object>

data ​

data: HealthCheckResponseBody

Defined in ​

src/index.ts:87

execute(apiFunction, data) ​

execute(apiFunction, data?): Promise<object>

Parameters ​

• apiFunction: "passwordlogin"

• data?: PasswordLoginRequestData

Returns ​

Promise<object>

data ​

data: PasswordLoginResponseBody

Defined in ​

src/index.ts:91

execute(apiFunction) ​

execute(apiFunction): Promise<object>

Parameters ​

• apiFunction: "queryserverstate"

Returns ​

Promise<object>

data ​

data: QueryServerStateResponseBody

Defined in ​

src/index.ts:95

getDefaultData() ​

getDefaultData<Data>(apiFunction): null | Data

Type Parameters ​

• Data

Parameters ​

• apiFunction: keyof ValidRequest

Returns ​

null | Data

Defined in ​

src/index.ts:70