strikt-core / strikt.api / DescribeableBuilder / describedAs

describedAs

abstract fun describedAs(description: String): Builder<T>

Adds a description to the assertion.

Parameters

description - a description of the subject of the assertion. The description may include a String.format style placeholder for the value itself.

Return
the same assertion with the new description applied.

abstract fun describedAs(descriptor: T.() -> String): Builder<T>

Adds a description to the assertion.

Parameters

descriptor - a function that returns a description for the subject of the assertion. The subject is the function's this so it's possible to use properties or method results of the subject in the description.

Return
the same assertion with the new description applied.