Class Config<TObject>

Class representing a Config.

Author

Mr. Stone evensstone@gmail.com

Type Parameters

TObject extends object = Record<PropertyKey, unknown>

Hierarchy (View Summary)

Proxiable
- Config

Index

Constructors

constructor

Methods

add all clear firstMatch get getMany has hasNot is isNot set setIf setItems toJson create fromJson

Constructors

`Protected`constructor

new Config<TObject extends object = Record<PropertyKey, unknown>>(
items?: any,
): Config<TObject>
Create a Config.
Type Parameters
- TObject extends object = Record<PropertyKey, unknown>
Parameters
- Optionalitems: any
  Initial configuration items.
Returns Config<TObject>

Overrides Proxiable.constructor

Methods

add

add<TValue>(key: PropertyKey, value: TValue): this
Add a value to an existing configuration key.
Type Parameters
- TValue
Parameters
- key: PropertyKey
  The key or keys to set as defaults.
- value: TValue
  The value to set as default.
Returns this
The current Config instance.

all

all(): TObject

Get all of the configuration items as a literal object.

Returns TObject
All configuration items.

clear

clear(): this

Clear all of the configuration items.

Returns this
The current Config instance.

firstMatch

firstMatch<TReturn = unknown>(keys: PropertyKey[]): TReturn
Get the first match configuration value.
Type Parameters
- TReturn = unknown
Parameters
- keys: PropertyKey[]
  An array of keys to check.
Returns TReturn
The first matching configuration value.
firstMatch<TReturn = unknown>(keys: PropertyKey[], fallback: TReturn): TReturn
Get the first match configuration value.
Type Parameters
- TReturn = unknown
Parameters
- keys: PropertyKey[]
  An array of keys to check.
- fallback: TReturn
  The fallback value if no key matches.
Returns TReturn
The first matching configuration value.

get

get<TReturn = unknown>(key: PropertyKey): TReturn
Get the specified configuration value.
Type Parameters
- TReturn = unknown
Parameters
- key: PropertyKey
  The key or keys to retrieve from the configuration.
Returns TReturn
The configuration value.
get<TReturn = unknown>(key: PropertyKey, fallback: TReturn): TReturn
Get the specified configuration value.
Type Parameters
- TReturn = unknown
Parameters
- key: PropertyKey
  The key or keys to retrieve from the configuration.
- fallback: TReturn
  The fallback value if the key does not exist.
Returns TReturn
The configuration value.

getMany

getMany<TReturn = Record<PropertyKey, unknown>>(
keys: Record<PropertyKey, unknown> | PropertyKey[],
): TReturn
Get many configuration values.
Type Parameters
- TReturn = Record<PropertyKey, unknown>
Parameters
- keys: Record<PropertyKey, unknown> | PropertyKey[]
  The keys to retrieve from the configuration.
Returns TReturn
An object containing the requested configuration values.

has

has(key: PropertyKey | PropertyKey[]): boolean
Determine if the given configuration value exists.
Parameters
- key: PropertyKey | PropertyKey[]
  The key or keys to check.
Returns boolean
True if the key exists, false otherwise.

hasNot

hasNot(key: PropertyKey | PropertyKey[]): boolean
Determine if the given configuration value does not exist.
Parameters
- key: PropertyKey | PropertyKey[]
  The key or keys to check.
Returns boolean
True if the key does not exist, false otherwise.

is

is(key: PropertyKey, value: unknown): boolean
Check if the given configuration value is equal to the specified value.
Parameters
- key: PropertyKey
  The key to check.
- value: unknown
  The value to compare against.
Returns boolean
True if the key's value is equal to the specified value, false otherwise.

isNot

isNot(key: PropertyKey, value: unknown): boolean
Check if the given configuration value is not equal to the specified value.
Parameters
- key: PropertyKey
  The key to check.
- value: unknown
  The value to compare against.
Returns boolean
True if the key's value is not equal to the specified value, false otherwise.

set

set<TValue>(
    key:
        | PropertyKey
        | PropertyKey[]
        | Record<string, TValue>
        | Record<PropertyKey, TValue>,
    value?: TValue,
): this
Set a given configuration value.
Type Parameters
- TValue
Parameters
- key:
      | PropertyKey
      | PropertyKey[]
      | Record<string, TValue>
      | Record<PropertyKey, TValue>
  The key or keys to set in the configuration.
- Optionalvalue: TValue
  The value to set.
Returns this
The current Config instance.

setIf

setIf<TValue>(key: PropertyKey | PropertyKey[], value?: TValue): this
Set a given configuration value if it does not exist.
Type Parameters
- TValue
Parameters
- key: PropertyKey | PropertyKey[]
  The key or keys to set in the configuration.
- Optionalvalue: TValue
  The value to set.
Returns this
The current Config instance.

setItems

setItems(items: TObject): this
Set all of the configuration items.
Parameters
- items: TObject
  The configuration items.
Returns this
The current Config instance.

toJson

toJson(): string

Get all of the configuration items as a JSON string.

Returns string
All configuration items as a JSON string.

`Static`create

create<TObject extends object = Record<PropertyKey, unknown>>(
items?: TObject,
): Config<TObject>
Create a Config.
Type Parameters
- TObject extends object = Record<PropertyKey, unknown>
Parameters
- Optionalitems: TObject
  Initial configuration items.
Returns Config<TObject>
A new Config instance.

`Static`fromJson

fromJson<TObject extends object = Record<PropertyKey, unknown>>(
items: string,
): Config<TObject>
Create a Config from a JSON string.
Type Parameters
- TObject extends object = Record<PropertyKey, unknown>
Parameters
- items: string
  The JSON string to create the Config from.
Returns Config<TObject>
A new Config instance.

Class Config<TObject>

Author

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns Config<TObject>

Methods

add

Type Parameters

Parameters

Returns this

all

Returns TObject

clear

Returns this

firstMatch

Type Parameters

Parameters

Returns TReturn

Type Parameters

Parameters

Returns TReturn

get

Type Parameters

Parameters

Returns TReturn

Type Parameters

Parameters

Returns TReturn

getMany

Type Parameters

Parameters

Returns TReturn

has

Parameters

Returns boolean

hasNot

Parameters

Returns boolean

is

Parameters

Returns boolean

isNot

Parameters

Returns boolean

set

Type Parameters

Parameters

Returns this

setIf

Type Parameters

Parameters

Returns this

setItems

Parameters

Returns this

toJson

Returns string

Staticcreate

Type Parameters

Parameters

Returns Config<TObject>

StaticfromJson

Type Parameters

Parameters

Returns Config<TObject>

Settings

On This Page

`Protected`constructor

`Static`create

`Static`fromJson