Packages > pkl > pkl.base

Regex0.27.0

Properties
Methods

external class Regex

A regular expression to match strings against.

Known subtypes:
Known usages:
All versions:

Properties

link
pattern: String

The pattern string of this regular expression.
Facts:
```
Regex("some pattern string").pattern == "some pattern string"
```

link

groupCount: Int

The number of capturing groups in this regular expression.

Returns zero if this regular expression does not have any capturing groups.

Facts:

Regex(#"abc"#).groupCount == 0
Regex(#"a(\s*)b(\s*)c"#).groupCount == 2 // `()` denotes a capturing group
Regex(#"a(?:\s*)bc"#).groupCount == 0    // `(?:)` denotes a non-capturing group

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)

Returns the class of this.
link

function

Any.toString(): String (pkl.base)

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)

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)

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

function

Typed.getProperty(name: String): unknown (pkl.base)

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)

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)

Converts this object to a Dynamic object.
link

function

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

Converts this object to a Map.
link

function

findMatchesIn(input: String): List<RegexMatch>

Finds all matches of this regular expression in input.

Also known as:

match
link

function

matchEntire(input: String): RegexMatch?

Matches this regular expression against the entire input.