package config
- Alphabetic
- By Inheritance
- config
- ConfigDocsModule
- ImplicitTupleConversion
- ConfigSyntax
- KeyConversionFunctions
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Package Members
Type Members
- trait ConfigDocsModule extends AnyRef
- sealed trait ConfigDocs extends AnyRef
ConfigDocsholds the descriptions and details of aConfigwhich can be used to produce documentation.ConfigDocsholds the descriptions and details of aConfigwhich can be used to produce documentation.- Definition Classes
- ConfigDocsModule
- sealed case class Table(rows: List[TableRow]) extends Product with Serializable
A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying to convert
ConfigDocsto a readable format.A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying to convert
ConfigDocsto a readable format.- Definition Classes
- ConfigDocsModule
- trait ImplicitTupleConversion extends AnyRef
- trait IndexedFlat extends Flat
- implicit final class Interpolator extends AnyVal
- trait TupleConversion[A, B] extends AnyRef
- implicit class ChunkOps[A] extends AnyRef
- Definition Classes
- ConfigSyntax
- implicit class ConfigErrorOps extends AnyRef
- Definition Classes
- ConfigSyntax
- implicit class ConfigOps[A] extends AnyRef
- Definition Classes
- ConfigSyntax
- implicit class FromConfigOps extends AnyRef
- Definition Classes
- ConfigSyntax
- implicit class FromConfigProviderOps extends AnyRef
- Definition Classes
- ConfigSyntax
Value Members
- def addPostFixToKey(string: String): (String) => String
Add a post fix to an existing key
Add a post fix to an existing key
- Definition Classes
- KeyConversionFunctions
- def addPrefixToKey(prefix: String): (String) => String
Add a prefix to an existing key
Add a prefix to an existing key
- Definition Classes
- KeyConversionFunctions
- implicit macro def autoTupleConversion[P <: Product, T]: TupleConversion[P, T]
- Definition Classes
- ImplicitTupleConversion
- def autoTupleConversion1[P, A](implicit ev: TupleConversion[P, (A)]): TupleConversion[P, A]
- Definition Classes
- ImplicitTupleConversion
- def camelToDelimiter(input: String, delimiter: String): String
Convert camelCase to any delimited string.
Convert camelCase to any delimited string. Example:
camelToDelimiter("abcDef", "-") === abc-def
- Definition Classes
- KeyConversionFunctions
- final def generateDocs[A](config: Config[A]): ConfigDocs
Generate documentation based on the
Config, where aConfigis a structure representing the logic to fetch the application config from various sources.Generate documentation based on the
Config, where aConfigis a structure representing the logic to fetch the application config from various sources.Once we generate the docs, this can be converted to a light weight
Tablestructure which is much more easier to be converted to markdown or json formats.Example :
val configDescriptor: Config[MyAppConfig] = ??? generatedDocs(configDescriptor).toTable.toGithubFlavouredMarkdown- Definition Classes
- ConfigDocsModule
- final def read[A](reader: Read[A]): IO[Error, A]
- Definition Classes
- ConfigSyntax
- val toKebabCase: (String) => String
Convert a camelCase key to kebab-case val s = abcDef toKebabCase(s) === abc-def
Convert a camelCase key to kebab-case val s = abcDef toKebabCase(s) === abc-def
- Definition Classes
- KeyConversionFunctions
- val toSnakeCase: (String) => String
Convert a camelCase key to snake_case
Convert a camelCase key to snake_case
- Definition Classes
- KeyConversionFunctions
- case object BuildInfo extends Product with Serializable
This object was generated by sbt-buildinfo.
- object Table extends Serializable
- Definition Classes
- ConfigDocsModule
- object IndexedFlat
- object TupleConversion