Package-level declarations

Functions

Link copied to clipboard
suspend fun only(): Void
suspend fun only(fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun only(name: String = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun only(options: TestOptions = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun only(name: String = undefined.unsafeCast<Nothing>(), options: TestOptions = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
Link copied to clipboard
external fun onlyAsync(): Promise<Void>
external fun onlyAsync(fn: SuiteFn = definedExternally): Promise<Void>
external fun onlyAsync(name: String = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>
external fun onlyAsync(options: TestOptions = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>

external fun onlyAsync(name: String = definedExternally, options: TestOptions = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>

Shorthand for marking a suite as only. This is the same as calling {@link describe} with options.only set to true.

Link copied to clipboard
suspend fun skip(): Void
suspend fun skip(fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun skip(name: String = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun skip(options: TestOptions = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun skip(name: String = undefined.unsafeCast<Nothing>(), options: TestOptions = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
Link copied to clipboard
external fun skipAsync(): Promise<Void>
external fun skipAsync(fn: SuiteFn = definedExternally): Promise<Void>
external fun skipAsync(name: String = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>
external fun skipAsync(options: TestOptions = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>

external fun skipAsync(name: String = definedExternally, options: TestOptions = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>

Shorthand for skipping a suite. This is the same as calling {@link describe} with options.skip set to true.

Link copied to clipboard
suspend fun todo(): Void
suspend fun todo(fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun todo(name: String = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun todo(options: TestOptions = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
suspend fun todo(name: String = undefined.unsafeCast<Nothing>(), options: TestOptions = undefined.unsafeCast<Nothing>(), fn: SuiteFn = undefined.unsafeCast<Nothing>()): Void
Link copied to clipboard
external fun todoAsync(): Promise<Void>
external fun todoAsync(fn: SuiteFn = definedExternally): Promise<Void>
external fun todoAsync(name: String = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>
external fun todoAsync(options: TestOptions = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>

external fun todoAsync(name: String = definedExternally, options: TestOptions = definedExternally, fn: SuiteFn = definedExternally): Promise<Void>

Shorthand for marking a suite as TODO. This is the same as calling {@link describe} with options.todo set to true.