Preparing search index...
The search index is not available
hein
hein
expect
Function expect
expect
<
T
>
(
actual
)
:
AllExpects
<
T
>
Type Parameters
T
extends
Loose
Parameters
actual
:
T
Returns
AllExpects
<
T
>
expect
<
T
>
(
actual
)
:
FunctionExpect
<
T
>
Type Parameters
T
extends
ThrowsCallback
Parameters
actual
:
T
Returns
FunctionExpect
<
T
>
expect
<
T
>
(
actual
)
:
PromiseExpect
<
T
>
Type Parameters
T
extends
Promise
<
any
>
Parameters
actual
:
T
Returns
PromiseExpect
<
T
>
expect
<
T
>
(
actual
)
:
ArrayExpect
<
T
>
Type Parameters
T
extends
any
[]
Parameters
actual
:
T
Returns
ArrayExpect
<
T
>
expect
<
T
>
(
actual
)
:
DateExpect
<
T
>
Type Parameters
T
extends
Date
Parameters
actual
:
T
Returns
DateExpect
<
T
>
expect
<
T
>
(
actual
)
:
MapExpect
<
T
>
Type Parameters
T
extends
Map
<
any
,
any
>
Parameters
actual
:
T
Returns
MapExpect
<
T
>
expect
<
T
>
(
actual
)
:
ObjectExpect
<
T
>
Type Parameters
T
extends
Record
<
string
,
any
>
Parameters
actual
:
T
Returns
ObjectExpect
<
T
>
expect
<
T
>
(
actual
)
:
NumberExpect
<
number
>
Type Parameters
T
extends
number
Parameters
actual
:
T
Returns
NumberExpect
<
number
>
expect
<
T
>
(
actual
)
:
BigIntExpect
<
bigint
>
Type Parameters
T
extends
bigint
Parameters
actual
:
T
Returns
BigIntExpect
<
bigint
>
expect
<
T
>
(
actual
)
:
BooleanExpect
<
boolean
>
Type Parameters
T
extends
boolean
Parameters
actual
:
T
Returns
BooleanExpect
<
boolean
>
expect
<
T
>
(
actual
)
:
StringExpect
<
string
>
Type Parameters
T
extends
string
Parameters
actual
:
T
Returns
StringExpect
<
string
>
expect
<
T
>
(
actual
)
:
SymbolExpect
<
T
>
Type Parameters
T
extends
symbol
Parameters
actual
:
T
Returns
SymbolExpect
<
T
>
expect
<
T
>
(
actual
)
:
ValueExpect
<
T
>
Type Parameters
T
Parameters
actual
:
T
Returns
ValueExpect
<
T
>
Index
Properties
fail
Properties
fail
fail
:
(
(
message
?:
string
)
=>
never
)
Type declaration
(
message
?
)
:
never
Throw an AssertionError
Parameters
message
:
string
= 'Fail'
The message to pass to the AssertionError
Returns
never
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
fail
hein
assert
assert
deepEqual
deepHasProperty
deepNotHasProperty
endsWith
equal
greaterThan
greaterThanEqual
hasKeys
hasMembers
hasProperty
hasSize
inBallpark
includes
instanceOf
isAfter
isBefore
isBetween
isEmpty
isType
lessThan
lessThanEqual
match
notAfter
notBefore
notBetween
notDeepEqual
notEndsWith
notEqual
notGreaterThan
notGreaterThanEqual
notHasKeys
notHasMembers
notHasProperty
notHasSize
notInBallpark
notIncludes
notInstanceOf
notIsEmpty
notIsType
notLessThan
notLessThanEqual
notMatch
notRejects
notRoundTo
notStartsWith
notThrows
rejects
roundTo
startsWith
throws
AssertionError
Alias
Method
Property
State
ErrorPredicate
ValueType
any
createEvaluation
expect
expectChain
fail
use
"
"
Throw an AssertionError