Class DirectoryConfig

The directories the global registry loads registry files from, in order (a later directory replaces an earlier one by codepoint). The default is the one directory ~/.known-values; an empty configuration loads nothing and makes the global registry equal to a reference build without the directory-loading feature.

Index

Constructors

Accessors

Methods

defaultOnly withPathsAndDefault defaultDirectory addPath

Constructors

constructor

new DirectoryConfig(paths?: readonly string[]): DirectoryConfig
Parameters
- paths: readonly string[] = []
  The directories, in order (none by default)
Returns DirectoryConfig

Throws
KnownValuesError InvalidParameter when paths is not an array of strings
- Defined in directory.ts:256

Accessors

paths

get paths(): readonly string[]
The directories, in order.

Returns readonly string[]
- Defined in directory.ts:285

Methods

`Static`defaultOnly

defaultOnly(): DirectoryConfig
The default directory only.

Returns DirectoryConfig
- Defined in directory.ts:261

`Static`withPathsAndDefault

withPathsAndDefault(paths: readonly string[]): DirectoryConfig
paths, then the default directory.
Parameters
- paths: readonly string[]
Returns DirectoryConfig
- Defined in directory.ts:266

`Static`defaultDirectory

defaultDirectory(): string
~/.known-values: the home directory is a non-empty HOME, else the account's home from the user database, else . (the reference's dirs::home_dir().unwrap_or(".")).

Returns string
- Defined in directory.ts:275

addPath

addPath(path: string): void
Appends a directory.
Parameters
- path: string
Returns void

Throws
KnownValuesError InvalidParameter when path is not a string
- Defined in directory.ts:294