EvaluatorSettings (pkl:0.32.0) • Packages

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

externalProperties: Mapping<String, String>?

The external properties available to Pkl, read using the prop: scheme.
link
env: Mapping<String, String>?

The environment variables available to Pkl, read using the env: scheme.
Example:
```
env {
  ["IS_PROD"] = "true"
}
```
link
allowedModules: Listing<String(isRegex)>?

The set of module URI patterns that can be imported.
Each element is a regular expression pattern that is tested against a module import.

Modules are imported either through an amends or extends clause, an import clause, or an import expression.

Example:
```
allowedModules {
  "https:"
  "file:"
  "package:"
  "projectpackage:"
}
```
link
allowedResources: Listing<String(isRegex)>?

The set of resource URI patterns that can be imported.
Each element is a regular expression pattern that is tested against a resource read.

Example:
```
allowedResources {
  "https:"
  "file:"
  "package:"
  "projectpackage:"
  "env:"
  "prop:"
}
```
link
color: ("never"|"auto"|"always")?

When to format messages with ANSI color codes.
Possible values:
- "never": Never format
- "auto": Format if the process' stdin, stdout, or stderr are connected to a console.
- "always": Always format
link

noCache: Boolean?

Disables the file system cache for package: modules.

When caching is disabled, packages are loaded over the network and stored in memory.
link

modulePath: Listing<String>?

A collection of jars, zips, or directories to be placed into the module path.

Module path modules and resources may be read and imported using the modulepath: scheme.
link

timeout: Duration?

The duration after which evaluation of a source module will be timed out.

Note that a timeout is treated the same as a program error in that any subsequent source modules will not be evaluated.
link

moduleCacheDir: String?

The directory where package: modules are cached.
link

rootDir: String?

Restricts access to file-based modules and resources to those located under this directory.
link

http: Http?

Configuration of outgoing HTTP requests.
link

externalModuleReaders: Mapping<String, ExternalReader>?

Configuration for external module reader processes.
link

externalResourceReaders: Mapping<String, ExternalReader>?

Configuration for external resource reader processes.
link
traceMode: ("compact"|"pretty")?

Defines options for the formatting of calls to the trace() method.
Possible values:
- "compact": All structures passed to trace() will be emitted on a single line.
- "pretty": All structures passed to trace() will be indented and emitted across multiple lines.

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

resolveForOs(enclosingUri: Uri, os: OperatingSystem): EvaluatorSettings

These evaluator settings, whose settings are resolved against enclosingUri using OS rules for os.
link

function
resolve(enclosingUri: Uri): EvaluatorSettings

These evaluator settings, whose settings are resolved to URIs against enclosingUri.
The following settings are resolved:
Returns file paths based on the host OS filesystem.

If ExternalReader.workingDir is null, it resolves to the ./ path off of enclosingUri.

On POSIX-based systems (like macOS and linux), this resolves to paths such as /path/to/dir.

On Windows, this resolves to drive letter paths such as C:\path\to\dir, or UNC paths such as \\network\share\path\to\dir.

Classes

link

class

Http

Settings that control how Pkl talks to HTTP(S) servers.
link

class

Proxy

Settings that control how Pkl talks to HTTP proxies.
link

class

ExternalReader

Type Aliases

link

typealias

HttpRewrite = String(startsWith(Regex("https?://")), endsWith("/"), hasNonEmptyHostname)

A key or value in Http.rewrites.
link

typealias

HttpHeaders = Mapping<HttpHeaderName, (Listing<HttpHeaderValue>|HttpHeaderValue)>(keys.toList().isDistinctBy((it) -> it.toLowerCase()))

A mapping of header names to header value(s).

The mapping must have distinct header keys (case insensitive).
link

typealias
HttpHeaderName = String(isNotReservedHeaderName, doesNotStartWithReservedPrefix, hasValidHeaderNameSyntax, isNotBlank)

An HTTP header name.
It conforms to the following rules:
- It is not one of "connection", "keep-alive", "content-length", "expect", "host", "upgrade", "te", "transfer-encoding", "trailer" (case insensitive).
- It does not start with "proxy-" nor "sec-".
- It consists of a-z, A-Z, or a character in "!#$%&'*+-.^_`|~".
- It is not a blank string.
link

typealias

HttpHeaderValue = String(matches(Regex(#"[\t\u0020-\u007E\u0080-\u00FF]*"#)), length < 4096)

An HTTP header value.

It consists of ASCII characters between the range of 0x20 - 0x7E, and 0x80 - 0xFF (all visible ASCII characters), and also the tab character.

pkl.EvaluatorSettings0.32.0

Properties(show inherited)

Methods(show inherited)

Classes

Type Aliases