Packages > pkg.pkl-lang.org/pkl-pantry/pkl.csv > pkl.csv.csv

Renderer1.0.0

Properties
Methods

class Renderer extends ValueRenderer

Renders values as CSV.

Known subtypes:
Known usages:
All versions:: 1.0.1, 1.0.0

Properties(show inherited)

link

converters: Mapping<Class, (unknown) -> Any>Source

Value converters to apply before values are rendered.

For further information see PcfRenderer.converters.
link

ValueRenderer.extension: String? (pkl.base)Source

The file extension associated with this output format, or null if this format does not have an extension.
link

lineBreak: String Source

The line break to use.

RFC 4180 states that line breaks are carriage-return-line-feed, but also:

As per section 4.1.1. of RFC 2046, this media type uses CRLF to denote line breaks. However, implementors should be aware that some implementations may use other values.

This property can be used to define which encoding to use.

(Default: "\r\n")
link
unification: "error"|"drop"|"pad"Source

How to handle polymorphic rows.
When rendering a table of Listing<Base>, which includes elements of type DerivedX and DerivedY (where both extends Base), how should this table be rendered? There are three options:
- "error" throws an error when any row has property names that are not in the header.
- "drop" only renders properties with names in the header and ignores any other properties.
- "pad" gathers property names from the entire table and inserts (pads) empty values when properties are missing.
(Default: "error")
link

includeHeader: Boolean Source

Tells whether to include a (first) line with the names of the columns.

Methods(show inherited)

link

function

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

Returns the class of this.
link

function

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

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)Source

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)Source

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

function

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

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)Source

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)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function

renderDocument(value: Any): unknownSource

Renders value as a complete document.

Some renderers impose restrictions on which types of values can be rendered as document.

A typical implementation of this method renders a document header/footer and otherwise delegates to renderValue().
link

function

renderValue(value: Any): unknownSource

Renders value.