zio-config
API
Generated with
zio-config/zio.config/ConfigDocsModule/Table

Table

zio.config.ConfigDocsModule.Table
See theTable companion object
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.

Value parameters

rows:

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

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Types

type Index = Int
type Size = Int

Value members

Concrete methods

def ++(that: Table): Table
def toConfluenceMarkdown(baseUrl: Option[String]): String

Create a Confluence flavored markdown string from Table. This can be used if you are planning to render this markdown in Atlassian's Confluence pages.

Create a Confluence flavored markdown string from Table. This can be used if you are planning to render this markdown in Atlassian's Confluence pages.

Value parameters

baseUrl:

Every heading in a markdown rendered through Atlassian's Confluence page needs to have a baseUrl. This can be the baseUrl of the confluence page in which markdown is rendered. The heading in markdown will be the keys of your application config.

Attributes

def toGithubFlavouredMarkdown: String

Create a Github flavored markdown string from Table. This can be used to render markdowns in Github, Gitlab etc

Create a Github flavored markdown string from Table. This can be used to render markdowns in Github, Gitlab etc

Attributes

def withFormat(format: Format): Table

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with