Pudu Docgen
Edit this page

Record

Reader

Module PuduLangDocgen.Configuration.Fields

type Reader = {
  file: Str,
  at: Str,
  fields: Array[(Str, Docgen.Meta)]
}

View source

The configuration file and the object being read

Fields

Name Type Description
file Str
at Str
fields Array[(Str, Docgen.Meta)]
Name Description
failure A configuration failure naming the dotted location of the value.
only Every key of an object is one of the allowed names.
nested A reader for the object stored under a key; a missing key reads as empty.
text Text under a key, or the fallback when it is missing.
flag A flag under a key, or the fallback when it is missing.
texts A list of text under a key; a single text counts as a list of one.
objects Readers for each object of a list under a key; a single object counts as a list of one.
directory A relative directory under a key: empty for the configuration folder, never leaving it.
sourceFolder A relative folder under a key that may start above the configuration folder with `../` segments; the rest must be a portable relative path.