Config

Defined in: src/config/Config.ts:28

Immutable configuration tree loaded from HOCON files and/or code overrides. All accessors throw ConfigError on missing or incorrectly-typed paths; hasPath lets callers probe beforehand.

Primary entry points:

• Config.load() — merge reference.conf + application.conf + env.
• Config.parseString(s) — parse an inline HOCON snippet.
• Config.parseFile(path) — parse a file.
• Config.fromObject(obj) — build from a plain JS object (code overrides).

Methods

atPath()

atPath(path): Config

Defined in: src/config/Config.ts:182

Wrap the tree under the given path: {a:{b:1}}.atPath(“x.y”) → {x:{y:{a:{b:1}}}}.

Parameters

path

string

Returns

Config

---

getBoolean()

getBoolean(path): boolean

Defined in: src/config/Config.ts:113

Parameters

path

string

Returns

boolean

---

getBytes()

getBytes(path): number

Defined in: src/config/Config.ts:133

Byte count.

Parameters

path

string

Returns

number

---

getConfig()

getConfig(path): Config

Defined in: src/config/Config.ts:162

Parameters

path

string

Returns

Config

---

getDuration()

getDuration(path): number

Defined in: src/config/Config.ts:125

Duration in milliseconds.

Parameters

path

string

Returns

number

---

getInt()

getInt(path): number

Defined in: src/config/Config.ts:100

Parameters

path

string

Returns

number

---

getList()

getList(path): ConfigValue[]

Defined in: src/config/Config.ts:150

Parameters

path

string

Returns

ConfigValue[]

---

getNumber()

getNumber(path): number

Defined in: src/config/Config.ts:106

Parameters

path

string

Returns

number

---

getObject()

getObject(path): ConfigObject

Defined in: src/config/Config.ts:156

Parameters

path

string

Returns

ConfigObject

---

getString()

getString(path): string

Defined in: src/config/Config.ts:93

Parameters

path

string

Returns

string

---

getStringList()

getStringList(path): string[]

Defined in: src/config/Config.ts:140

Parameters

path

string

Returns

string[]

---

hasPath()

hasPath(path): boolean

Defined in: src/config/Config.ts:89

Parameters

path

string

Returns

boolean

---

merge()

merge(overlay): Config

Defined in: src/config/Config.ts:177

Inverse of withFallback — layer overlay on top.

Parameters

overlay

Config

Returns

Config

---

toJSON()

toJSON(): ConfigObject

Defined in: src/config/Config.ts:193

Deep-clone the underlying tree as a plain object.

Returns

ConfigObject

---

withFallback()

withFallback(other): Config

Defined in: src/config/Config.ts:172

Merge other underneath this config — i.e. values defined here win, keys that only exist in other are filled in.

Parameters

other

Config

Returns

Config

---

empty()

static empty(): Config

Defined in: src/config/Config.ts:33

Returns

Config

---

fromObject()

static fromObject(obj): Config

Defined in: src/config/Config.ts:45

Parameters

obj

unknown

Returns

Config

---

load()

static load(options?): Config

Defined in: src/config/Config.ts:64

Load the standard config chain. Precedence (highest first):

1. overrides passed in code.
2. application.conf resolved via appConfPath → process.env.ACTOR_TS_CONFIG → ./application.conf in CWD.
3. reference.conf bundled with this package.

Environment variables are consulted during substitution resolution (inside each parse step), not as a separate layer.

Parameters

options?

LoadOptions = {}

Returns

Config

---

loadReference()

static loadReference(): Config

Defined in: src/config/Config.ts:81

Returns

Config

---

parseFile()

static parseFile(path): Config

Defined in: src/config/Config.ts:40

Parameters

path

string

Returns

Config

---

parseString()

static parseString(source): Config

Defined in: src/config/Config.ts:35

Parameters

source

string

Returns

Config