kommander-core/kommander

Package-level declarations

Types

expect interface Expect<out E>

actual interface Expect<out E>

actual interface Expect<out E>

object ExpectBuilders

ExpectCollection

interface ExpectCollection<out E> : Expect<Collection<E>?>

interface ExpectLambda : Expect<() -> Unit>

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreJs

actual typealias IgnoreJs = Ignore

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreNative

actual typealias IgnoreNative = <Error class: unknown class>

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreOSX

actual typealias IgnoreOSX = Ignore

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION])

expect annotation class IgnoreWatchOs

actual typealias IgnoreWatchOs = Ignore

Functions

fun <E> expect(value: E): Expect<E>

fun <E> expect(vararg value: E): ExpectCollection<E>

fun <E> expect(collection: Collection<E>?): ExpectCollection<E>

inline fun <E> expect(value: E, builder: Expect<E>.() -> Unit): Expect<E>

fun <E> expectArray(array: Array<E>): ExpectCollection<E>

expectCollection

fun <E> expectCollection(collection: Collection<E>?): ExpectCollection<E>

fun expectFunction(lambda: () -> Unit): ExpectLambda

inline fun <E> expectMany(value: Collection<E>, builder: ExpectCollection<E>.() -> Unit): ExpectCollection<E>

external fun <T> require(module: String): T

requireFromRootDir

fun <T> requireFromRootDir(path: String): T

inline fun <E> Expect<Any?>.toBe(): E

inline fun <E> Expect<E>.toBeEqualTo(expected: E, message: String? = null)

toBeGreaterThan

fun <T : Comparable<T>> Expect<T>.toBeGreaterThan(expected: T)

toBeGreaterThanOrEqualTo

fun <T : Comparable<T>> Expect<T>.toBeGreaterThanOrEqualTo(expected: T)

inline fun <E> Expect<Any?>.toBeInstanceOf(message: String? = null): Expect<E>

fun <T : Comparable<T>> Expect<T>.toBeLessThan(expected: T)

toBeLessThanOrEqualTo

fun <T : Comparable<T>> Expect<T>.toBeLessThanOrEqualTo(expected: T)

inline fun <T> Expect<T>.toBeUnequalTo(expected: T, message: String? = null)

inline fun Expect<String?>.toContain(other: String, ignoreCase: Boolean = true, message: String? = null)

inline fun <T : Throwable> ExpectLambda.toFailWith(): T