Class ScreepsConfigManager

Provides features to find and load save configuration files.

This class supports the SS3 Unified Credentials File format as well as the screeps.json format used by many Screeps code upload tools.

Index

Guides

Configuration and Credential Files

Other

constructor defaultPaths loadConfig loadFile loadNormalizedConfig normalizeClientConfig normalizeServerConfig normalizeServersConfig

Other

constructor

new ScreepsConfigManager(): ScreepsConfigManager
Returns ScreepsConfigManager

defaultPaths

get defaultPaths(): readonly string[]
List all paths that will be searched by default for config files.

If the SCREEPS_CONFIG environment variable is defined, this path defined there will always be searched first.

Returns readonly string[]
- Defined in src/ScreepsConfigManager.ts:60

loadConfig

loadConfig(
serverName: string,
opts?: LoadConfigOptions,
): Promise<ScreepsHttpConfig | null>
Search for config files and load the first one found.

If LoadConfigOptions.file is defined and non-empty, that path will always be checked first. Otherwise, defaultPaths will be checked in order until.
Parameters
- serverName: string
  the name of the server to use from the credential file
- Optionalopts: LoadConfigOptions
  see LoadConfigOptions
Returns Promise<ScreepsHttpConfig | null>
a valid ScreepsHttpConfig if one was found

Throws
Error if a file exists but the contents are invalid/malformed
- Defined in src/ScreepsConfigManager.ts:118

loadFile

loadFile(file: string): Promise<ScreepsJsonConfig | ScreepsYamlConfig | null>
Parameters
- file: string
Returns Promise<ScreepsJsonConfig | ScreepsYamlConfig | null>
- Defined in src/ScreepsConfigManager.ts:159

loadNormalizedConfig

loadNormalizedConfig(
    file: string,
    serverName: string,
    opts?: LoadConfigOptions,
): Promise<ScreepsHttpConfig | null>
Parameters
- file: string
- serverName: string
- Optionalopts: LoadConfigOptions
Returns Promise<ScreepsHttpConfig | null>
- Defined in src/ScreepsConfigManager.ts:141

normalizeClientConfig

normalizeClientConfig(
parsed: ScreepsJsonConfig | ScreepsYamlConfig,
clientOpts?: string | Partial<ScreepsAppConfig>,
): ScreepsAppConfig
Parameters
- parsed: ScreepsJsonConfig | ScreepsYamlConfig
- OptionalclientOpts: string | Partial<ScreepsAppConfig>
Returns ScreepsAppConfig
- Defined in src/ScreepsConfigManager.ts:245

normalizeServerConfig

normalizeServerConfig(rawServer: ScreepsRawServerConfig): ScreepsServerConfig
Parameters
- rawServer: ScreepsRawServerConfig
Returns ScreepsServerConfig
- Defined in src/ScreepsConfigManager.ts:205

normalizeServersConfig

normalizeServersConfig(
parsed: ScreepsJsonConfig | ScreepsYamlConfig,
serverName: string,
): ScreepsServerConfig
Parameters
- parsed: ScreepsJsonConfig | ScreepsYamlConfig
- serverName: string
Returns ScreepsServerConfig
- Defined in src/ScreepsConfigManager.ts:188