Packages > pkg.pkl-lang.org/pkl-pantry/org.json_schema.contrib

org.json_schema.contrib.internal.utils1.1.1

Properties
Methods

module org.json_schema.contrib.internal.utils

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/org.json_schema.contrib@1.1.1#/internal/utils.pkl
Source code:: utils.pkl
Known subtypes:
Known usages:
All versions:

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

THIS: BuiltInKeywordExpressionNode Source

Node representing this.
link

DEPRECATED: AnnotationNode Source

Node representing @Deprecated

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
pascalCase(text: String): unknownSource

Renders the string in pascal case.
Underscores, dashes and dots are all considered word separators.

Facts:
```
pascalCase("foo-bar") == "FooBar"
pascalCase("foo.bar") == "FooBar"
pascalCase("foo_bar") == "FooBar"
pascalCase("fooBar") == "FooBar"
```
link

function

numberLiteral(num: Number): unknownSource

Creates a node equivalent of a number
link

function

declaredType(type: String): unknownSource

Creates a declared type
link

function

declaredType1(type: Type, isImport: Boolean): unknownSource
link

function

binaryOperatorNode(_lhs: ExpressionNode, _operator: BinaryOperator, _rhs: ExpressionNode): BinaryOperatorExpressionNode Source

Helper for creating ExpressionNode.BinaryOperatorExpressionNode
link

function

mergeSchemas(baseSchema: JsonSchema, rest: List<Schema>): unknownSource

Merge multiple schemas into one schema document.
link

function

_findMatchingSubSchemas(schema: JsonSchema, path: List<String>, predicate: (JsonSchema) -> Boolean): Map<List<String>, JsonSchema>Source
link

function

findMatchingSubschemas(schema: JsonSchema, predicate: (JsonSchema) -> Boolean): Map<List<String>, JsonSchema>Source

Traverse the schema, returning all schemas that match predicate.

Returns a map whose key is the path to that schema, and value is the schema itself.