docs
API
Generated with
docs/zio.config

zio.config

package zio.config

Members list

Packages

package zio.config.derivation
package zio.config.magnolia
package zio.config.refined
package zio.config.syntax
package zio.config.typesafe
package zio.config.yaml

Type members

Classlikes

case object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
BuildInfo.type
trait ConfigDocsModule

Attributes

Supertypes
class Object
trait Matchable
class Any
trait ImplicitTupleConversion

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait IndexedFlat extends Flat

Attributes

Companion
object
Supertypes
trait Flat
class Object
trait Matchable
class Any
object IndexedFlat

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
final implicit class Interpolator(sc: StringContext) extends AnyVal

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
trait TupleConversion[A, B]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object TupleConversion extends ImplicitTupleConversion

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type

Inherited classlikes

implicit class ChunkOps[A](chunk: Chunk[A])

Attributes

Inherited from:
ConfigSyntax
Supertypes
class Object
trait Matchable
class Any
sealed trait ConfigDocs

ConfigDocs holds the descriptions and details of a Config which can be used to produce documentation.

ConfigDocs holds the descriptions and details of a Config which can be used to produce documentation.

Attributes

Inherited from:
ConfigDocsModule
Supertypes
class Object
trait Matchable
class Any
implicit class ConfigErrorOps(error: Error)

Attributes

Inherited from:
ConfigSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class ConfigOps[A](config: Config[A])

Attributes

Inherited from:
ConfigSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class FromConfigOps(c: Config.type)

Attributes

Inherited from:
ConfigSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class FromConfigProviderOps(c: ConfigProvider.type)

Attributes

Inherited from:
ConfigSyntax
Supertypes
class Object
trait Matchable
class Any
sealed case class Table(rows: List[TableRow])

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.

Value parameters

rows:

A table consist of multiple TableRows where each TableRow holds the information about the config path.

Attributes

Inherited from:
ConfigDocsModule
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Table

Attributes

Inherited from:
ConfigDocsModule
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any

Value members

Inherited methods

def addPostFixToKey(string: String): String => String

Add a post fix to an existing key

Add a post fix to an existing key

Attributes

Inherited from:
KeyConversionFunctions (hidden)
def addPrefixToKey(prefix: String): String => String

Add a prefix to an existing key

Add a prefix to an existing key

Attributes

Inherited from:
KeyConversionFunctions (hidden)
def camelToDelimiter(input: String, delimiter: String): String

Convert camelCase to any delimited string. Example:

Convert camelCase to any delimited string. Example:

 camelToDelimiter("abcDef", "-") === abc-def

Attributes

Inherited from:
KeyConversionFunctions (hidden)
final def generateDocs[A](config: Config[A]): ConfigDocs

Generate documentation based on the Config, where a Config is a structure representing the logic to fetch the application config from various sources.

Generate documentation based on the Config, where a Config 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: Config[MyAppConfig] = ???

 generatedDocs(configDescriptor).toTable.toGithubFlavouredMarkdown

Attributes

Inherited from:
ConfigDocsModule
final def read[A](reader: ReadZIO[A]): IO[Error, A]

Attributes

Inherited from:
ConfigSyntax
final def read[A](reader: Read[A]): IO[Error, A]

Attributes

Inherited from:
ConfigSyntax

Inherited fields

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

Attributes

Inherited from:
KeyConversionFunctions (hidden)
val toSnakeCase: String => String

Convert a camelCase key to snake_case

Convert a camelCase key to snake_case

Attributes

Inherited from:
KeyConversionFunctions (hidden)

Givens

Inherited givens

given autoTupleConversion[Prod <: Product](using m: ProductOf[Prod]): TupleConversion[Prod, m.MirroredElemTypes]

Attributes

Inherited from:
ImplicitTupleConversion
inline given autoTupleConversion1[Prod <: Product, A](using c: TupleConversion[Prod, Tuple1[A]]): autoTupleConversion1[Prod, A]

Attributes

Inherited from:
ImplicitTupleConversion

Implicits

Implicits

final implicit def Interpolator(sc: StringContext): Interpolator

Inherited implicits

final implicit def ChunkOps[A](chunk: Chunk[A]): ChunkOps[A]

Attributes

Inherited from:
ConfigSyntax
final implicit def ConfigErrorOps(error: Error): ConfigErrorOps

Attributes

Inherited from:
ConfigSyntax
final implicit def ConfigOps[A](config: Config[A]): ConfigOps[A]

Attributes

Inherited from:
ConfigSyntax
final implicit def FromConfigOps(c: Config.type): FromConfigOps

Attributes

Inherited from:
ConfigSyntax
final implicit def FromConfigProviderOps(c: ConfigProvider.type): FromConfigProviderOps

Attributes

Inherited from:
ConfigSyntax
Generated with