Class: IQConfig

config.IQConfig

IQConfig class for managing BBS configuration

Table of contents

Constructors

• constructor

Accessors

• display
• logging
• network
• paths
• security
• server

Methods

• deleteCustom
• ensureDirectories
• fromJSON
• get
• getAll
• getCustom
• isLoaded
• load
• reset
• resetSection
• save
• set
• setAll
• setCustom
• toJSON
• validate

Constructors

constructor

• new IQConfig(configPath?)

Parameters

Name	Type	Default value
configPath	string	"./iniquity.json"

Defined in

core/src/config.ts:185

Accessors

display

• get display(): IDisplayConfig

Get display configuration

Returns

IDisplayConfig

Defined in

core/src/config.ts:312

• set display(config): void

Set display configuration

Parameters

Name	Type
config	Partial<IDisplayConfig>

Returns

void

Defined in

core/src/config.ts:319

---

logging

• get logging(): ILoggingConfig

Get logging configuration

Returns

ILoggingConfig

Defined in

core/src/config.ts:354

• set logging(config): void

Set logging configuration

Parameters

Name	Type
config	Partial<ILoggingConfig>

Returns

void

Defined in

core/src/config.ts:361

---

network

• get network(): INetworkConfig

Get network configuration

Returns

INetworkConfig

Defined in

core/src/config.ts:340

• set network(config): void

Set network configuration

Parameters

Name	Type
config	Partial<INetworkConfig>

Returns

void

Defined in

core/src/config.ts:347

---

paths

• get paths(): IPathsConfig

Get paths configuration

Returns

IPathsConfig

Defined in

core/src/config.ts:298

• set paths(config): void

Set paths configuration

Parameters

Name	Type
config	Partial<IPathsConfig>

Returns

void

Defined in

core/src/config.ts:305

---

security

• get security(): ISecurityConfig

Get security configuration

Returns

ISecurityConfig

Defined in

core/src/config.ts:326

• set security(config): void

Set security configuration

Parameters

Name	Type
config	Partial<ISecurityConfig>

Returns

void

Defined in

core/src/config.ts:333

---

server

• get server(): IServerConfig

Get server configuration

Returns

IServerConfig

Defined in

core/src/config.ts:284

• set server(config): void

Set server configuration

Parameters

Name	Type
config	Partial<IServerConfig>

Returns

void

Defined in

core/src/config.ts:291

Methods

deleteCustom

▸ deleteCustom(key): boolean

Delete custom configuration value

Parameters

Name	Type
key	string

Returns

boolean

Defined in

core/src/config.ts:382

---

ensureDirectories

▸ ensureDirectories(): void

Ensure all required directories exist

Returns

void

Defined in

core/src/config.ts:486

---

fromJSON

▸ fromJSON(json): boolean

Import configuration from JSON string

Parameters

Name	Type
json	string

Returns

boolean

Defined in

core/src/config.ts:517

---

get

▸ get<T>(path): undefined | T

Get a specific config value by path (e.g., ‘server.name’)

Type parameters

Name	Type
T	any

Parameters

Name	Type
path	string

Returns

undefined | T

Defined in

core/src/config.ts:393

---

getAll

▸ getAll(): IBBSConfig

Get full configuration

Returns

IBBSConfig

Defined in

core/src/config.ts:269

---

getCustom

▸ getCustom<T>(key): undefined | T

Get custom configuration value

Type parameters

Name	Type
T	any

Parameters

Name	Type
key	string

Returns

undefined | T

Defined in

core/src/config.ts:368

---

isLoaded

▸ isLoaded(): boolean

Check if config was loaded from file

Returns

boolean

Defined in

core/src/config.ts:262

---

load

▸ load(): boolean

Load configuration from file

Returns

boolean

Defined in

core/src/config.ts:223

---

reset

▸ reset(): void

Reset configuration to defaults

Returns

void

Defined in

core/src/config.ts:431

---

resetSection

▸ resetSection(section): void

Reset a specific section to defaults

Parameters

Name	Type
section	keyof IBBSConfig

Returns

void

Defined in

core/src/config.ts:438

---

save

▸ save(): boolean

Save configuration to file

Returns

boolean

Defined in

core/src/config.ts:243

---

set

▸ set(path, value): boolean

Set a specific config value by path (e.g., ‘server.name’)

Parameters

Name	Type
path	string
value	any

Returns

boolean

Defined in

core/src/config.ts:411

---

setAll

▸ setAll(config): void

Set full configuration

Parameters

Name	Type
config	Partial<IBBSConfig>

Returns

void

Defined in

core/src/config.ts:277

---

setCustom

▸ setCustom(key, value): void

Set custom configuration value

Parameters

Name	Type
key	string
value	any

Returns

void

Defined in

core/src/config.ts:375

---

toJSON

▸ toJSON(): string

Export configuration as JSON string

Returns

string

Defined in

core/src/config.ts:510

---

validate

▸ validate(): Object

Validate configuration

Returns

Object

Name	Type
errors	string[]
valid	boolean

Defined in

core/src/config.ts:447