kotlin-node/node.assert

Package-level declarations

Types

Link copied to clipboard
external class AssertionError

Indicates the failure of an assertion. All errors thrown by the node:assert module will be instances of the AssertionError class.

Link copied to clipboard
sealed external interface AssertionErrorOptions
Link copied to clipboard
typealias AssertPredicate = Any
Link copied to clipboard
external class CallTracker

This feature is deprecated and will be removed in a future version. Please consider using alternatives such as the mock helper function.

Link copied to clipboard
sealed external interface CallTrackerCall
Link copied to clipboard
sealed external interface CallTrackerReportInformation

Functions

Link copied to clipboard
external fun assert(value: Any?)
external fun assert(value: Any?, message: <Error class: unknown class> = definedExternally)
external fun assert(value: Any?, message: String = definedExternally)

An alias of {@link ok}.

Link copied to clipboard
external fun <T> deepEqual(actual: Any?, expected: T)
external fun <T> deepEqual(actual: Any?, expected: T, message: <Error class: unknown class> = definedExternally)
external fun <T> deepEqual(actual: Any?, expected: T, message: String = definedExternally)

Tests for deep equality between the actual and expected parameters. "Deep" equality means that the enumerable "own" properties of child objects are recursively evaluated also by the following rules.

Link copied to clipboard
external fun doesNotMatch(value: String, regExp: <Error class: unknown class>)
external fun doesNotMatch(value: String, regExp: <Error class: unknown class>, message: <Error class: unknown class> = definedExternally)
external fun doesNotMatch(value: String, regExp: <Error class: unknown class>, message: String = definedExternally)

Expects the string input not to match the regular expression.

Link copied to clipboard
suspend external fun doesNotReject(block: <Error class: unknown class><Any?>): <Error class: unknown class>
suspend external fun doesNotReject(    block: <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun doesNotReject(block: <Error class: unknown class><Any?>, message: String = definedExternally): <Error class: unknown class>
suspend external fun doesNotReject(    block: () -> <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun doesNotReject(    block: () -> <Error class: unknown class><Any?>,     message: String = definedExternally): <Error class: unknown class>

Awaits the asyncFn promise or, if asyncFn is a function, immediately calls the function and awaits the returned promise to complete. It will then check that the promise is not rejected.

suspend external fun doesNotReject(block: () -> <Error class: unknown class><Any?>): <Error class: unknown class>
suspend external fun doesNotReject(block: <Error class: unknown class><Any?>, error: AssertPredicate): <Error class: unknown class>
suspend external fun doesNotReject(block: () -> <Error class: unknown class><Any?>, error: AssertPredicate): <Error class: unknown class>
suspend external fun doesNotReject(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun doesNotReject(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class>
suspend external fun doesNotReject(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun doesNotReject(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class>
Link copied to clipboard
external fun doesNotRejectAsync(block: <Error class: unknown class><Any?>): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(block: () -> <Error class: unknown class><Any?>): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: <Error class: unknown class><Any?>,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: () -> <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: () -> <Error class: unknown class><Any?>,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>

Awaits the asyncFn promise or, if asyncFn is a function, immediately calls the function and awaits the returned promise to complete. It will then check that the promise is not rejected.

external fun doesNotRejectAsync(    block: <Error class: unknown class><Any?>,     error: AssertPredicate): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun doesNotRejectAsync(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
external fun doesNotThrow(block: () -> Any?)
external fun doesNotThrow(block: () -> Any?, message: <Error class: unknown class> = definedExternally)
external fun doesNotThrow(block: () -> Any?, message: String = definedExternally)

Asserts that the function fn does not throw an error.

external fun doesNotThrow(block: () -> Any?, error: AssertPredicate)
external fun doesNotThrow(block: () -> Any?, error: AssertPredicate, message: <Error class: unknown class> = definedExternally)
external fun doesNotThrow(block: () -> Any?, error: AssertPredicate, message: String = definedExternally)
Link copied to clipboard
external fun <T> equal(actual: Any?, expected: T)
external fun <T> equal(actual: Any?, expected: T, message: <Error class: unknown class> = definedExternally)
external fun <T> equal(actual: Any?, expected: T, message: String = definedExternally)

Tests strict equality between the actual and expected parameters as determined by Object.is().

Link copied to clipboard
external fun fail(): Nothing
external fun fail(message: <Error class: unknown class> = definedExternally): Nothing
external fun fail(message: String = definedExternally): Nothing

Throws an AssertionError with the provided error message or a default error message. If the message parameter is an instance of an Error then it will be thrown instead of the AssertionError.

external fun fail(actual: Any?, expected: Any?): Nothing
external fun fail(    actual: Any?,     expected: Any?,     message: <Error class: unknown class> = definedExternally,     operator: String = definedExternally,     stackStartFn: Function<*> = definedExternally): Nothing
external fun fail(    actual: Any?,     expected: Any?,     message: String = definedExternally,     operator: String = definedExternally,     stackStartFn: Function<*> = definedExternally): Nothing
Link copied to clipboard
external fun ifError(value: Any?)

Throws value if value is not undefined or null. This is useful when testing the error argument in callbacks. The stack trace contains all frames from the error passed to ifError() including the potential new frames for ifError() itself.

Link copied to clipboard
external fun match(value: String, regExp: <Error class: unknown class>)
external fun match(value: String, regExp: <Error class: unknown class>, message: <Error class: unknown class> = definedExternally)
external fun match(value: String, regExp: <Error class: unknown class>, message: String = definedExternally)

Expects the string input to match the regular expression.

Link copied to clipboard
external fun notDeepEqual(actual: Any?, expected: Any?)
external fun notDeepEqual(actual: Any?, expected: Any?, message: <Error class: unknown class> = definedExternally)
external fun notDeepEqual(actual: Any?, expected: Any?, message: String = definedExternally)

Tests for deep strict inequality. Opposite of {@link deepStrictEqual}.

Link copied to clipboard
external fun notEqual(actual: Any?, expected: Any?)
external fun notEqual(actual: Any?, expected: Any?, message: <Error class: unknown class> = definedExternally)
external fun notEqual(actual: Any?, expected: Any?, message: String = definedExternally)

Tests strict inequality between the actual and expected parameters as determined by Object.is().

Link copied to clipboard
external fun ok(value: Any?)
external fun ok(value: Any?, message: <Error class: unknown class> = definedExternally)
external fun ok(value: Any?, message: String = definedExternally)

Tests if value is truthy. It is equivalent to assert.equal(!!value, true, message).

Link copied to clipboard
external fun partialDeepStrictEqual(actual: Any?, expected: Any?)
external fun partialDeepStrictEqual(actual: Any?, expected: Any?, message: <Error class: unknown class> = definedExternally)
external fun partialDeepStrictEqual(actual: Any?, expected: Any?, message: String = definedExternally)

assert.partialDeepStrictEqual() Asserts the equivalence between the actual and expected parameters through a deep comparison, ensuring that all properties in the expected parameter are present in the actual parameter with equivalent values, not allowing type coercion. The main difference with assert.deepStrictEqual() is that assert.partialDeepStrictEqual() does not require all properties in the actual parameter to be present in the expected parameter. This method should always pass the same test cases as assert.deepStrictEqual(), behaving as a super set of it.

Link copied to clipboard
suspend external fun rejects(block: <Error class: unknown class><Any?>): <Error class: unknown class>
suspend external fun rejects(    block: <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun rejects(block: <Error class: unknown class><Any?>, message: String = definedExternally): <Error class: unknown class>
suspend external fun rejects(    block: () -> <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun rejects(block: () -> <Error class: unknown class><Any?>, message: String = definedExternally): <Error class: unknown class>

Awaits the asyncFn promise or, if asyncFn is a function, immediately calls the function and awaits the returned promise to complete. It will then check that the promise is rejected.

suspend external fun rejects(block: () -> <Error class: unknown class><Any?>): <Error class: unknown class>
suspend external fun rejects(block: <Error class: unknown class><Any?>, error: AssertPredicate): <Error class: unknown class>
suspend external fun rejects(block: () -> <Error class: unknown class><Any?>, error: AssertPredicate): <Error class: unknown class>
suspend external fun rejects(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun rejects(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class>
suspend external fun rejects(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class>
suspend external fun rejects(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class>
Link copied to clipboard
external fun rejectsAsync(block: <Error class: unknown class><Any?>): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(block: () -> <Error class: unknown class><Any?>): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: <Error class: unknown class><Any?>,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: () -> <Error class: unknown class><Any?>,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: () -> <Error class: unknown class><Any?>,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>

Awaits the asyncFn promise or, if asyncFn is a function, immediately calls the function and awaits the returned promise to complete. It will then check that the promise is rejected.

external fun rejectsAsync(    block: <Error class: unknown class><Any?>,     error: AssertPredicate): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: <Error class: unknown class> = definedExternally): <Error class: unknown class><<Error class: unknown class>>
external fun rejectsAsync(    block: () -> <Error class: unknown class><Any?>,     error: AssertPredicate,     message: String = definedExternally): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
external fun throws(block: () -> Any?)
external fun throws(block: () -> Any?, message: <Error class: unknown class> = definedExternally)
external fun throws(block: () -> Any?, message: String = definedExternally)

Expects the function fn to throw an error.

external fun throws(block: () -> Any?, error: AssertPredicate)
external fun throws(block: () -> Any?, error: AssertPredicate, message: <Error class: unknown class> = definedExternally)
external fun throws(block: () -> Any?, error: AssertPredicate, message: String = definedExternally)