Packages > pkl > pkl.analyze

ImportGraph0.28.1

Properties
Methods

class ImportGraph

The graph of imports declared (directly and transitively) by the modules passed to importGraph().

Known subtypes:
Known usages:
All versions:: 0.29.0-dev, 0.28.1, 0.28.0, 0.28.0-dev, 0.27.2, 0.27.1, 0.27.0

Properties

link

imports: Map<Uri, Set<Import>>

The imports declared within a Pkl program.

Each entry maps a module URI to the set of imports declared in that module.

The set of all modules in the graph can be obtained via its keys.
link

resolvedImports: Map<Uri, Uri>(keys == imports.keys)

Mappings of modules from their in-language URI, to their resolved URI.

A module's in-language URI is the form used within Pkl source code. For example, modulepath-based modules have form modulepath:/path/to/my/module.pkl.

A module's resolved URI is the form used to load the module's contents. The same modulepath module might have form jar:file:///path/to/file.zip!/path/to/my/module.pkl if Pkl run with --module-path /path/to/file.zip.

Dependency-notation imports, such as "@myPackage/myModule.pkl", are represented as in-language URIs with scheme projectpackage:. In the case of local project dependencies, they will be local URIs resolved from the project file URI (in normal cases, file: URIs).

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.