Class ConfigSection<Val>

A class that represents the user-config section of the JSON file used as simple database.

Type Parameters

Val extends JsonValue = JsonValue

Hierarchy

AbstractJsonFileSection<Val>
- ConfigSection

Index

Constructors

constructor

new ConfigSection<Val>(file, name): ConfigSection<Val>
Creates an instance of AbstractJsonFileSection.
Type Parameters
- Val extends JsonValue = JsonValue
Parameters
- file: cli.JsonFile
  
  The parent JsonFile instance.
- name: string
  
  The name of the section.
Returns ConfigSection<Val>
Overrides AbstractJsonFileSection.constructor
- Defined in packages/cli/src/db/ConfigSection.ts:30

Properties

`Readonly` defaultValues

defaultValues: Record<string, Val> = {}

The default values for the section.

`Readonly` descriptions

descriptions: Record<string, string> = {}

Descriptions for each property key.

`Readonly` file

file: cli.JsonFile

The parent JsonFile instance.

`Protected` isInitialized

isInitialized: boolean = false

Indicates whether the section has been initialized.

`Protected` `Readonly` keysAreFixed

keysAreFixed: boolean

Indicates whether the keys in the section are fixed.

`Protected` `Readonly` name

name: string

The name of the section.

`Readonly` parsers

parsers: Record<string, TStringParser<Val>> = {}

String parsers for when editing config from command-line.

`Readonly` prefixBaseString

prefixBaseString: string

The base string used as a prefix for the section.

`Readonly` validators

validators: Record<string, TValidator<Val>> = {}

Validators for each property key.

Accessors

cmd

get cmd(): CommandBuilder<unknown[], OptionValues>
The CommandBuilder associated with the section.

Returns CommandBuilder<unknown[], OptionValues>
Inherited from AbstractJsonFileSection.cmd
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:64

db

get db(): JsonDB
The JsonDB associated with the section.

Returns JsonDB
Inherited from AbstractJsonFileSection.db
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:57

keys

get keys(): string[]
Gets the keys in the section.

Returns string[]
The keys in the section.
Inherited from AbstractJsonFileSection.keys
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:112

Methods

assertValid

assertValid(key, value): void
Asserts that a key-value pair is valid.
Parameters
- key: string
  
  The key to assert.
- value: Val
  
  The value to assert.
Returns void
Overrides AbstractJsonFileSection.assertValid
- Defined in packages/cli/src/db/ConfigSection.ts:39

count

count(): number
Gets the number of keys in the section.

Returns number
The number of keys in the section.
Inherited from AbstractJsonFileSection.count
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:121

defineProperty

defineProperty(key, options): void
Defines a property for the section.
Parameters
- key: string
  
  The key of the property.
- options: IConfig<Val>
  
  The options for the property.
Returns void
Overrides AbstractJsonFileSection.defineProperty
- Defined in packages/cli/src/db/ConfigSection.ts:49

delete

delete(key, save?): void
Deletes the value associated with the specified key.
Parameters
- key: string
  
  The key to delete.
- save: boolean = true
  
  Indicates whether to save the section after deleting the value.
Returns void
Inherited from AbstractJsonFileSection.delete
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:190

deleteAll

deleteAll(save?): void
Deletes all the values in the section.
Parameters
- save: boolean = true
  
  Indicates whether to save the section after deleting the values.
Returns void
Inherited from AbstractJsonFileSection.deleteAll
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:199

edit

edit(editor?): void
Edits the values in the section using a text editor.
Parameters
- Optional editor: string
  
  The text editor to use. If not specified, the default text editor command will be used.
Returns void
Inherited from AbstractJsonFileSection.edit
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:210

get

get<T>(key): T
Gets the value associated with the specified key.
Type Parameters
- T extends JsonValue = Val
Parameters
- key: string
  
  The key to get the value for.
Returns T
The value associated with the key.
Inherited from AbstractJsonFileSection.get
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:94

getAll

getAll(): Record<string, Val>
Gets all the values in the section.

Returns Record<string, Val>
All the values in the section.
Inherited from AbstractJsonFileSection.getAll
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:103

initialize

initialize(save?): void
Initializes the section.
Parameters
- save: boolean = false
  
  Indicates whether to save the section after initialization.
Returns void
A string if an error occurred during initialization, otherwise void.
Overrides AbstractJsonFileSection.initialize
- Defined in packages/cli/src/db/ConfigSection.ts:63

prefix

prefix(key?): string
Gets the object path prefix as dot-separated keys for this section of the JSON file database.
Parameters
- Optional key: string
  
  An optional key to append to the prefix path.
Returns string
The object path prefix.

Throws
An error if the keys are fixed and the specified key does not exist in the default values.
Inherited from AbstractJsonFileSection.prefix
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:82

reset

reset(key, save?): void
Resets the value associated with the specified key to its default value.
Parameters
- key: string
  
  The key to reset.
- save: boolean = true
  
  Indicates whether to save the section after resetting the value.
Returns void
Inherited from AbstractJsonFileSection.reset
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:173

resetAll

resetAll(save?): void
Resets all the values in the section to their default values.
Parameters
- save: boolean = true
  
  Indicates whether to save the section after resetting the values.
Returns void
Inherited from AbstractJsonFileSection.resetAll
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:181

save

save(): Promise<void>
Saves the section.

Returns Promise<void>
A promise that resolves when the section is saved.
Inherited from AbstractJsonFileSection.save
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:72

set

set(key, value, save?): void
Sets the value associated with the specified key.
Parameters
- key: string
  
  The key to set the value for.
- value: Val
  
  The value to set.
- save: boolean = true
  
  Indicates whether to save the section after setting the value.
Returns void
Inherited from AbstractJsonFileSection.set
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:131

setAll

setAll(values, save?): void
Sets all the values in the section.
Parameters
- values: Record<string, Val>
  
  The values to set.
- save: boolean = true
  
  Indicates whether to save the section after setting the values.
Returns void
Inherited from AbstractJsonFileSection.setAll
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:142

update

update(key, callback, save?): void
Updates the value associated with the specified key.
Parameters
- key: string
  
  The key to set the value for.
- callback: ((val, key) => Val)
  
  The callback function that returns the new value.
  - - (val, key): Val
    - Parameters
      
      val: Val
      
      key: string
      
      Returns Val
- save: boolean = true
  
  Indicates whether to save the section after setting the value.
Returns void
Inherited from AbstractJsonFileSection.update
- Defined in packages/cli/src/db/AbstractJsonFileSection.ts:164

Class ConfigSection<Val>

Type Parameters

Val extends JsonValue = JsonValue

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Val extends JsonValue = JsonValue

Parameters

file: cli.JsonFile

name: string

Returns ConfigSection<Val>

Properties

Readonly defaultValues

Readonly descriptions

Readonly file

Protected isInitialized

Protected Readonly keysAreFixed

Protected Readonly name

Readonly parsers

Readonly prefixBaseString

Readonly validators

Accessors

cmd

Returns CommandBuilder<unknown[], OptionValues>

db

Returns JsonDB

keys

Returns string[]

Methods

assertValid

Parameters

key: string

value: Val

Returns void

count

Returns number

defineProperty

Parameters

key: string

options: IConfig<Val>

Returns void

delete

Parameters

key: string

save: boolean = true

Returns void

deleteAll

Parameters

save: boolean = true

Returns void

edit

Parameters

Optional editor: string

Returns void

get

Type Parameters

T extends JsonValue = Val

Parameters

key: string

Returns T

getAll

Returns Record<string, Val>

initialize

Parameters

save: boolean = false

Returns void

prefix

Parameters

Optional key: string

Returns string

Throws

reset

Parameters

key: string

`Readonly` defaultValues

`Readonly` descriptions

`Readonly` file

`Protected` isInitialized

`Protected` `Readonly` keysAreFixed

`Protected` `Readonly` name

`Readonly` parsers

`Readonly` prefixBaseString

`Readonly` validators

`Optional` editor: string

`Optional` key: string