Interface AssertFunction

Callable [[Assert]] interface.

Hierarchy

Assert
- AssertFunction

AssertFunction(condition, message?): void
Asserts that condition is truthy.
Parameters
- condition: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if condition is falsy.
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:19

Methods

compareEqual

compareEqual(lhs, rhs, message?): void
Asserts that lhs [[Values.compare structurally orders the same as]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does not structurally order before or the same as rhs.
Inherited from Assert.compareEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:163

compareGreaterThan

compareGreaterThan(lhs, rhs, message?): void
Asserts that lhs [[Values.compare structurally orders after]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does not structurally order after rhs.
Inherited from Assert.compareGreaterThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:187

compareGreaterThanOrEqual

compareGreaterThanOrEqual(lhs, rhs, message?): void
Asserts that lhs [[Values.compare structurally orders after or the same as]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does not structurally order after or the same as rhs.
Inherited from Assert.compareGreaterThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:175

compareLessThan

compareLessThan(lhs, rhs, message?): void
Asserts that lhs [[Values.compare structurally orders before]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does not structurally order before rhs.
Inherited from Assert.compareLessThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:139

compareLessThanOrEqual

compareLessThanOrEqual(lhs, rhs, message?): void
Asserts that lhs [[Values.compare structurally orders before or the same as]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does not structurally order before or the same as rhs.
Inherited from Assert.compareLessThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:151

compareNotEqual

compareNotEqual(lhs, rhs, message?): void
Asserts that lhs does not [[Values.compare structurally order the same as]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does structurally order before or the same as rhs.
Inherited from Assert.compareNotEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:169

compareNotGreaterThan

compareNotGreaterThan(lhs, rhs, message?): void
Asserts that lhs does not [[Values.compare structurally order after]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does structurally order after rhs.
Inherited from Assert.compareNotGreaterThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:193

compareNotGreaterThanOrEqual

compareNotGreaterThanOrEqual(lhs, rhs, message?): void
Asserts that lhs does not [[Values.compare structurally order after or the same as]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does structurally order after or the same as rhs.
Inherited from Assert.compareNotGreaterThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:181

compareNotLessThan

compareNotLessThan(lhs, rhs, message?): void
Asserts that lhs does not [[Values.compare structurally order before]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does structurally order before rhs.
Inherited from Assert.compareNotLessThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:145

compareNotLessThanOrEqual

compareNotLessThanOrEqual(lhs, rhs, message?): void
Asserts that lhs does not [[Values.compare structurally order before or the same as]] rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs does structurally order before or the same as rhs.
Inherited from Assert.compareNotLessThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:157

equal

equal(lhs, rhs, message?): void
Asserts that lhs is [[Values.equal structurally equal]] to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is not structurally equal to rhs.
Inherited from Assert.equal
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:115

equivalent

equivalent(lhs, rhs, message?): void
Asserts that lhs is [[Values.equivalent structurally equivalent]] to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is not structurally equivalent to rhs.
Inherited from Assert.equivalent
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:127

greaterThan

greaterThan(lhs, rhs, message?): void
Asserts that lhs is greater than (>) rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is not greater than (!>) rhs.
Inherited from Assert.greaterThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:67

greaterThanOrEqual

greaterThanOrEqual(lhs, rhs, message?): void
Asserts that lhs is greater than or equal (>=) to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is not greater than or equal (!>=) to rhs.
Inherited from Assert.greaterThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:73

identical

identical(lhs, rhs, message?): void
Asserts that lhs is identical (===) to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is not identical (!==) to rhs.
Inherited from Assert.identical
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:43

instanceOf

instanceOf(object, constructor, message?): void
Asserts that object has the prototype of constructor in its prototype chain.
Parameters
- object: unknown
- constructor: Function
- Optional message: string
Returns void

Throws
[[AssertException]] with message if object does not have the prototype of constructor in its prototype chain.
Inherited from Assert.instanceOf
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:103

lessThan

lessThan(lhs, rhs, message?): void
Asserts that lhs is less than (<) rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is not less than (!<) rhs.
Inherited from Assert.lessThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:55

lessThanOrEqual

lessThanOrEqual(lhs, rhs, message?): void
Asserts that lhs is less than or equal (<=) to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is not less than or equal (!<=) to rhs.
Inherited from Assert.lessThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:61

notEqual

notEqual(lhs, rhs, message?): void
Asserts that lhs is not [[Values.equal structurally equal]] to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is structurally equal to rhs.
Inherited from Assert.notEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:121

notEquivalent

notEquivalent(lhs, rhs, message?): void
Asserts that lhs is not [[Values.equivalent structurally equivalent]] to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is structurally equivalent to rhs.
Inherited from Assert.notEquivalent
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:133

notGreaterThan

notGreaterThan(lhs, rhs, message?): void
Asserts that lhs is not greater than (!>) rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is greater than (>) rhs.
Inherited from Assert.notGreaterThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:91

notGreaterThanOrEqual

notGreaterThanOrEqual(lhs, rhs, message?): void
Asserts that lhs is not greater than or equal (!>=) to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is greater than or equal (>=) to rhs.
Inherited from Assert.notGreaterThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:97

notIdentical

notIdentical(lhs, rhs, message?): void
Asserts that lhs is not identical (!==) to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is identical (===) to rhs.
Inherited from Assert.notIdentical
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:49

notInstanceOf

notInstanceOf(object, constructor, message?): void
Asserts that object does not have the prototype of constructor in its prototype chain.
Parameters
- object: unknown
- constructor: Function
- Optional message: string
Returns void

Throws
[[AssertException]] with message if object does have the prototype of constructor in its prototype chain.
Inherited from Assert.notInstanceOf
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:109

notLessThan

notLessThan(lhs, rhs, message?): void
Asserts that lhs is not less than (!<) rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is less than (<) rhs.
Inherited from Assert.notLessThan
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:79

notLessThanOrEqual

notLessThanOrEqual(lhs, rhs, message?): void
Asserts that lhs is not less than or equal (!<=) to rhs.
Parameters
- lhs: unknown
- rhs: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if lhs is less than or equal (<=) to rhs.
Inherited from Assert.notLessThanOrEqual
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:85

notOk

notOk(condition, message?): void
Asserts that condition is falsy.
Parameters
- condition: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if condition is truthy.
Inherited from Assert.notOk
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:37

ok

ok(condition, message?): void
Asserts that condition is truthy.
Parameters
- condition: unknown
- Optional message: string
Returns void

Throws
[[AssertException]] with message if condition is falsy.
Inherited from Assert.ok
- Defined in swim-core/swim-util/lib/main/Assert.d.ts:31

Generated using TypeDoc