trait ConfigModule extends ConfigDocsModule with ReadModule with WriteModule
- Alphabetic
- By Inheritance
- ConfigModule
- ReadModule
- ConfigDocsModule
- WriteModule
- ConfigDescriptorModule
- ConfigSourceModule
- KeyValueModule
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- sealed trait ConfigDescriptor[A] extends AnyRef
- Definition Classes
- ConfigDescriptorModule
- trait ConfigDescriptorFunctions extends AnyRef
- Definition Classes
- ConfigDescriptorModule
- sealed trait ConfigDocs extends AnyRef
ConfigDocs
holds the descriptions and details of aConfigDescriptor
which can be used to produce documentation.ConfigDocs
holds the descriptions and details of aConfigDescriptor
which 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
ConfigDocs
to a readable format.A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying to convert
ConfigDocs
to a readable format.- Definition Classes
- ConfigDocsModule
- abstract type K
- Definition Classes
- KeyValueModule
- abstract type V
- Definition Classes
- KeyValueModule
- trait ConfigSource extends AnyRef
- Definition Classes
- ConfigSourceModule
- trait ConfigSourceFunctions extends AnyRef
- Definition Classes
- ConfigSourceModule
- case class ConfigSourceName(name: String) extends Product with Serializable
- Definition Classes
- ConfigSourceModule
- sealed trait LeafForSequence extends AnyRef
To specify if a singleton leaf should be considered as a valid sequence or not.
To specify if a singleton leaf should be considered as a valid sequence or not.
- Definition Classes
- ConfigSourceModule
Value Members
- object Table extends Serializable
- Definition Classes
- ConfigDocsModule
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def generateDocs[A](config: ConfigDescriptor[A]): ConfigDocs
Generate documentation based on the
ConfigDescriptor
, where aConfigDescriptor
is a structure representing the logic to fetch the application config from various sources.Generate documentation based on the
ConfigDescriptor
, where aConfigDescriptor
is 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
Table
structure which is much more easier to be converted to markdown or json formats.Example :
val configDescriptor: ConfigDescriptor[MyAppConfig] = ??? generatedDocs(configDescriptor).toTable.toGithubFlavouredMarkdown
- Definition Classes
- ConfigDocsModule
- def generateReport[A](config: ConfigDescriptor[A], value: A): Either[String, ConfigDocs]
Generate a report based on the
ConfigDescriptor
and anA
, where aConfigDescriptor
represents the logic to fetch the application config from various sources, andA
represents the actual config value that was retrieved.Generate a report based on the
ConfigDescriptor
and anA
, where aConfigDescriptor
represents the logic to fetch the application config from various sources, andA
represents the actual config value that was retrieved.- Definition Classes
- ConfigDocsModule
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def getConfig[A](implicit tag: zio.Tag[A]): ZIO[Has[A], Nothing, A]
- def getConfigSource(sourceNames: Set[ConfigSourceName], getTree: (List[K]) => PropertyTree[K, V], isLeafValidSequence: LeafForSequence): ConfigSource
- Attributes
- protected
- Definition Classes
- ConfigSourceModule
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def read[A](configuration: ConfigDescriptor[A]): Either[ReadError[K], A]
- Definition Classes
- ReadModule
- final def requiredZipAndOrFields[A](config: ConfigDescriptor[A]): Int
- Definition Classes
- ReadModule
- def sizeOfZipAndOrErrors(error: ReadError[K]): Int
- Definition Classes
- ReadModule
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def write[A](config: ConfigDescriptor[A], a: A): Either[String, PropertyTree[K, V]]
- Definition Classes
- WriteModule
- object ConfigSourceFunctions extends ConfigSourceFunctions
- Attributes
- protected
- Definition Classes
- ConfigSourceModule
- object LeafForSequence
- Definition Classes
- ConfigSourceModule