YamlRenderer0.31.0

Overview
Properties
Methods

class YamlRenderer extends ValueRenderer

Renders values as YAML.

Known subtypes in package:
Known usages in package:
All versions:

To render a YAML stream, set isStream to true.

The yaml.Property annotation can be used to change how a property name renders into YAML.

Example:

import "pkl:yaml"

@yaml.Property { name = "wing_span" }
wingSpan: Int

Properties(show inherited)

link
BaseValueRenderer.converters: Mapping<(Class|String), (unknown) -> Any> (pkl.base)

Value converters to apply before values are rendered.
A value converter is a function that converts a value to another value immediately before the value is rendered (and after the value has been type-checked). The converted value is then rendered by the renderer's hardwired rendering logic.

When a converter returns a value of type Object, Collection, Map, or Pair, converters are recursively applied to the returned value's components (object properties, list elements, etc.).

At most one converter is applied per value. If multiple converters are applicable, a winner is chosen as follows:
- A converter with String key wins over a converter with Class key.
- Between multiple String key converters, the converter defined earlier (according to the mapping's definition order) wins.
- Between multiple Class key converters, the most specific class (according to class hierarchy) wins.
A converter's key specifies which values the converter should be applied to. A converter with Class key is applied to values of that class, including values of its subclasses. A converter with String key is applied to values whose path matches the path spec described by the string.

Path specs can have the following components:
- ^ matches the top-level value passed to renderDocument() or renderValue() (often the module object)
- pigeon matches property pigeon at any hierarchy level
- [pigeon] matches map(ping) entry with String key "pigeon" at any hierarchy level
- * matches any property
- [*] matches any list(ing) element or map(ping) entry
Here are some examples of valid property paths:
- "server"
- "server.timeout"
- "^server.timeout" (matches server.timeout, but not racks[12345].server.timeout)
- "racks[12345].server"
- "racks[*].server
Paths are matched against path specs component-wise in reverse order. For example, paths server.timeout and racks[*].server.timeout both match path spec server.timeout, whereas path server.timeout.millis does not.
link

BaseValueRenderer.convertPropertyTransformers: Mapping<Class, Mixin<ConvertProperty>> (pkl.base)

Customizations for ConvertProperty annotation behaviors.

This property is consulted to transform ConvertProperty annotation values. This can be used to customize or override the conversion behavior for a specific renderer. If multiple entries match the annotation's class, the most specific class (according to class hierarchy) wins.

See ConvertProperty for detailed information.
link

BaseValueRenderer.extension: String? (pkl.base)

The file extension associated with this output format, or null if this format does not have an extension.
link
mode: "compat"|"1.1"|"1.2"

The YAML version used by consumers of the rendered documents.
- "compat" - YAML 1.1 or 1.2 (default)
- "1.1" - YAML 1.1
- "1.2" - YAML 1.2 (Core schema)
At present, the mode only affects which String values are quoted in YAML. For example, x = "yes" is rendered as x: 'yes' in modes "compat" and "1.1", and as x: yes in mode "1.2".
link

indentWidth: Int(this > 1)

The number of spaces to use for indenting output.
link

omitNullProperties: Boolean

Whether to skip rendering properties whose value is null.
link

isStream: Boolean

If true, renderDocument expects an argument of type Listing or Collection and renders it as YAML stream.

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)

Converts this object to a Map.
link

function

renderDocument(value: Any): String

Renders value as a YAML document.

Every YAML value is a valid YAML document.
link

function

renderValue(value: Any): String

Renders value as YAML value.