Packages > pkl > pkl.Project

EvaluatorSettings0.25.0-dev

Properties
Methods

class EvaluatorSettings

Known subtypes:
Known usages:
All versions:

Properties

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

noCache: Boolean?

Disables the file system cache for package: modules.

When cacheing 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.

Relative paths are resolved against PklProject's enclosing directory.
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.

Relative paths are resolved against PklProject's enclosing directory.
link

rootDir: String?

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

Relative paths are resolved against PklProject's enclosing directory.

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.