Interface Assert

Type that implements common assertion functions.

Hierarchy

Assert

Index

Methods

Methods

compareEqual

compareEqual(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:97
Asserts that lhs structurally orders the same as rhs.

throws

AssertException with message if lhs does not structurally order before or the same as rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareGreaterThan

compareGreaterThan(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:125
Asserts that lhs structurally orders after rhs.

throws

AssertException with message if lhs does not structurally order after rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareGreaterThanOrEqual

compareGreaterThanOrEqual(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:111
Asserts that lhs structurally orders after or the same as rhs.

throws

AssertException with message if lhs does not structurally order after or the same as rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareLessThan

compareLessThan(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:69
Asserts that lhs structurally orders before rhs.

throws

AssertException with message if lhs does not structurally order before rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareLessThanOrEqual

compareLessThanOrEqual(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:83
Asserts that lhs structurally orders before or the same as rhs.

throws

AssertException with message if lhs does not structurally order before or the same as rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareNotEqual

compareNotEqual(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:104
Asserts that lhs does not structurally order the same as rhs.

throws

AssertException with message if lhs does structurally order before or the same as rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareNotGreaterThan

compareNotGreaterThan(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:132
Asserts that lhs does not structurally order after rhs.

throws

AssertException with message if lhs does structurally order after rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareNotGreaterThanOrEqual

compareNotGreaterThanOrEqual(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:118
Asserts that lhs does not structurally order after or the same as rhs.

throws

AssertException with message if lhs does structurally order after or the same as rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareNotLessThan

compareNotLessThan(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:76
Asserts that lhs does not structurally order before rhs.

throws

AssertException with message if lhs does structurally order before rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

compareNotLessThanOrEqual

compareNotLessThanOrEqual(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:90
Asserts that lhs does not structurally order before or the same as rhs.

throws

AssertException with message if lhs does structurally order before or the same as rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

equal

equal(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:41
Asserts that lhs is structurally equal to rhs.

throws

AssertException with message if lhs is not structurally equal to rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

identity

identity(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:55
Asserts that lhs is identical (===) to rhs.

throws

AssertException with message if lhs is not identical (!==) to rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

notEqual

notEqual(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:48
Asserts that lhs is not structurally equal to rhs.

throws

AssertException with message if lhs is structurally equal to rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

notIdentity

notIdentity(lhs: unknown, rhs: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:62
Asserts that lhs is not identical (!==) to rhs.

throws

AssertException with message if lhs is identical (===) to rhs.

Parameters
- lhs: unknown
- rhs: unknown
- Optional message: undefined | string
Returns void

notOk

notOk(condition: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:34
Asserts that condition is falsy.

throws

AssertException with message if condition is truthy.

Parameters
- condition: unknown
- Optional message: undefined | string
Returns void

ok

ok(condition: unknown, message?: undefined | string): void

- Defined in swim-core-js/@swim/util/main/Assert.ts:27
Asserts that condition is truthy.

throws

AssertException with message if condition is falsy.

Parameters
- condition: unknown
- Optional message: undefined | string
Returns void