Skip to content

@vttforge/core / PackageConfig

Class: PackageConfig ​

Settings for one package, system or module.

Constructors ​

Constructor ​

new PackageConfig(packageId): PackageConfig

Parameters ​

packageId ​

string

Returns ​

PackageConfig

Properties ​

packageId ​

readonly packageId: string

The package id every call is made against.

Accessors ​

systemId ​

Get Signature ​

get systemId(): string

The package id.

Deprecated ​

Read packageId. This class covers modules too, and the old name says otherwise. The property stays for the rest of the 0.x line.

Returns ​

string

Methods ​

get() ​

get<T>(key): T

Type Parameters ​

T ​

T

Parameters ​

key ​

string

Returns ​

T


isRegistered() ​

isRegistered(key): boolean

Parameters ​

key ​

string

Returns ​

boolean


register() ​

register<T>(key, config): void

Type Parameters ​

T ​

T

Parameters ​

key ​

string

config ​

SettingConfig<T>

Returns ​

void


set() ​

set<T>(key, value): Promise<T>

Type Parameters ​

T ​

T

Parameters ​

key ​

string

value ​

T

Returns ​

Promise<T>

MIT licensed.