Index
Modules:
scrolls
,
scrolls/configFile
,
scrolls/configProvider
,
scrolls/configReader
,
scrolls/envFileParser
,
scrolls/envProvider
,
scrolls/jsonProvider
,
scrolls/tomlProvider
.
API symbols
`$`:
configProvider: proc `$`(value: ConfigValue): string
Bool:
configProvider: ConfigValueKind.Bool
BoolList:
configProvider: ConfigValueKind.BoolList
ConfigurationProvider:
configProvider: type ConfigurationProvider
ConfigurationReader:
configReader: object ConfigurationReader
ConfigValue:
configProvider: object ConfigValue
ConfigValueKind:
configProvider: enum ConfigValueKind
convertKey:
envProvider: proc convertKey(key: string): string
Double:
configProvider: ConfigValueKind.Double
DoubleList:
configProvider: ConfigValueKind.DoubleList
EnvProvider:
envProvider: type EnvProvider
get:
configReader: proc get(reader: ConfigurationReader; key: string; typ: typedesc[bool]): Option[bool]
configReader: proc get[T](reader: ConfigurationReader; key: string; typ: typedesc[Option[T]]): Option[ T]
configReader: proc get(reader: ConfigurationReader; key: string; typ: typedesc[seq[bool]]): Option[ seq[bool]]
configReader: proc get(reader: ConfigurationReader; key: string; typ: typedesc[seq[string]]): Option[ seq[string]]
configReader: proc get[T: SomeInteger](reader: ConfigurationReader; key: string; typ: typedesc[seq[T]]): Option[seq[T]]
configReader: proc get[T: SomeFloat](reader: ConfigurationReader; key: string; typ: typedesc[seq[T]]): Option[seq[T]]
configReader: proc get(reader: ConfigurationReader; key: string; typ: typedesc[string]): Option[ string]
configReader: proc get[T: SomeInteger](reader: ConfigurationReader; key: string; typ: typedesc[T]): Option[ T]
configReader: proc get[T: SomeFloat](reader: ConfigurationReader; key: string; typ: typedesc[T]): Option[ T]
configReader: proc get[T: Serialisable](reader: ConfigurationReader; typ: typedesc[T]): T
getConfigFile:
configFile: proc getConfigFile(appName: string; default: JsonNode): Path
configFile: proc getConfigFile(appName, ext: string; default: proc (): string): Path
initConfigurationReader:
configReader: proc initConfigurationReader(providers: varargs[ConfigurationProvider]): ConfigurationReader
Int:
configProvider: ConfigValueKind.Int
IntList:
configProvider: ConfigValueKind.IntList
InvalidConfigValue:
configProvider: type InvalidConfigValue
JsonProvider:
jsonProvider: type JsonProvider
newEnvProvider:
envProvider: proc newEnvProvider(envFile = Path(".env")): EnvProvider
newJsonProvider:
jsonProvider: proc newJsonProvider(data: JsonNode): JsonProvider
jsonProvider: proc newJsonProvider(file: Path): JsonProvider
jsonProvider: proc newJsonProvider(stream: Stream): JsonProvider
newTomlProvider:
tomlProvider: proc newTomlProvider(file: Path): TomlProvider
tomlProvider: proc newTomlProvider(stream: Stream): TomlProvider
tomlProvider: proc newTomlProvider(data: TomlValueRef): TomlProvider
parseEnvFile:
envFileParser: proc parseEnvFile(data: string): Table[string, string]
Serialisable:
configReader: type Serialisable
String:
configProvider: ConfigValueKind.String
StringList:
configProvider: ConfigValueKind.StringList
TomlProvider:
tomlProvider: type TomlProvider
value:
configProvider: method value(provider: ConfigurationProvider; key: string; kind: ConfigValueKind): Option[ ConfigValue]
envProvider: method value(provider: EnvProvider; key: string; kind: ConfigValueKind): Option[ ConfigValue]
jsonProvider: method value(provider: JsonProvider; key: string; kind: ConfigValueKind): Option[ ConfigValue]
tomlProvider: method value(provider: TomlProvider; key: string; kind: ConfigValueKind): Option[ ConfigValue]