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

pkl.pipe.yaml1.0.2

Overview
Properties
Methods
Type Aliases

module pkl.pipe.yaml extends pkl.pipe.text

CLI tool for working with YAML in Pkl, kind of like yq or yq.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/pkl.pipe@1.0.2#/yaml.pkl
Pkl version:: 0.24.0 or higher
Source code:: yaml.pkl
Known subtypes:
Known usages:
All versions:

Example usage:

# Get the number of replicas in a Kubernetes deployment YAML file
pkl eval package://pkg.pkl-lang.org/pkl-pantry/pkl.pipe@<VERSION>#/yaml.pkl -x 'pipe.spec.replicas' < deployment.yaml

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

hidden

input: Resource(!this.text.trimEnd().isEmpty) (pkl.pipe.text)Source
link

pipe: (List<Value>|Value)?Source
link

stdin: (List<Value>|Value)?Source
link

hidden

yamlRenderer: YamlRenderer (pkl.pipe.text)Source
link

hidden

asYaml: RenderFunc (pkl.pipe.text)Source
link

hidden

toYaml: RenderFunc (pkl.pipe.text)Source
link

hidden

asYAML: RenderFunc (pkl.pipe.text)Source
link

hidden

toYAML: RenderFunc (pkl.pipe.text)Source
link

hidden

jsonRenderer: JsonRenderer (pkl.pipe.text)Source
link

hidden

asJson: RenderFunc (pkl.pipe.text)Source
link

hidden

toJson: RenderFunc (pkl.pipe.text)Source
link

hidden

asJSON: RenderFunc (pkl.pipe.text)Source
link

hidden

toJSON: RenderFunc (pkl.pipe.text)Source
link

hidden

formatted: unknown (pkl.pipe.text)Source
link

hidden

parser: Parser Source

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

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

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

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

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

function

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

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

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

asYaml(value: unknown): String (pkl.pipe.text)Source
link

function

asJson(value: unknown): String (pkl.pipe.text)Source

Type Aliases(show inherited)

link

typealias

RenderFunc = (Any) -> String (pkl.pipe.text)Source