Class: TypedConfigBound<T>
Defined in: packages/config-bound/src/configBound.ts:176
Type Parameters
| Type Parameter |
|---|
T extends ConfigSchema |
Constructors
Constructor
new TypedConfigBound<T>(configBound): TypedConfigBound<T>;Defined in: packages/config-bound/src/configBound.ts:179
Parameters
| Parameter | Type |
|---|---|
configBound | ConfigBound |
Returns
TypedConfigBound<T>
Accessors
binds
Get Signature
get binds(): Bind[];Defined in: packages/config-bound/src/configBound.ts:186
Returns
Bind[]
name
Get Signature
get name(): string;Defined in: packages/config-bound/src/configBound.ts:183
Returns
string
sections
Get Signature
get sections(): Section[];Defined in: packages/config-bound/src/configBound.ts:189
Returns
Section[]
Methods
addBind()
addBind(bind): void;Defined in: packages/config-bound/src/configBound.ts:193
Parameters
| Parameter | Type |
|---|---|
bind | Bind |
Returns
void
addSection()
addSection(section): void;Defined in: packages/config-bound/src/configBound.ts:197
Parameters
| Parameter | Type |
|---|---|
section | Section |
Returns
void
get()
get<K, E>(sectionName, elementName): Promise<
| InferConfigType<T>[K][E]
| undefined>;Defined in: packages/config-bound/src/configBound.ts:205
Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
E extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
sectionName | K |
elementName | E |
Returns
Promise< | InferConfigType<T>[K][E] | undefined>
getOrThrow()
getOrThrow<K, E>(sectionName, elementName): Promise<InferConfigType<T>[K][E]>;Defined in: packages/config-bound/src/configBound.ts:215
Type Parameters
| Type Parameter |
|---|
K extends string | number | symbol |
E extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
sectionName | K |
elementName | E |
Returns
Promise<InferConfigType<T>[K][E]>
getSections()
getSections(): Section[];Defined in: packages/config-bound/src/configBound.ts:201
Returns
Section[]
getValidationErrors()
getValidationErrors(): Promise<object[]>;Defined in: packages/config-bound/src/configBound.ts:229
Returns
Promise<object[]>
validate()
validate(): Promise<void>;Defined in: packages/config-bound/src/configBound.ts:225
Returns
Promise<void>